diff --git a/Makefile b/Makefile index 438be05a..ba1e399e 100644 --- a/Makefile +++ b/Makefile @@ -3,7 +3,7 @@ TEST_OPTS=-v -test.timeout 300s GIT_USER_ID?=koyeb GIT_REPO_ID?=koyeb-api-client-python OPENAPI_GENERATOR_VERSION?=latest -PACKAGE_VERSION?=1.6.1 +PACKAGE_VERSION?=1.6.2 DOCKER ?= docker diff --git a/bumpver.toml b/bumpver.toml index d1b0142d..9d06a695 100644 --- a/bumpver.toml +++ b/bumpver.toml @@ -1,5 +1,5 @@ [tool.bumpver] -current_version = "1.6.1" +current_version = "1.6.2" version_pattern = "MAJOR.MINOR.PATCH[PYTAGNUM]" commit = false tag = false diff --git a/koyeb/__init__.py b/koyeb/__init__.py index 8e4b6997..c7bd2452 100644 --- a/koyeb/__init__.py +++ b/koyeb/__init__.py @@ -1,6 +1,6 @@ # coding: utf-8 -__version__ = "1.6.1" +__version__ = "1.6.2" # Make Sandbox available at package level from .sandbox import Sandbox, AsyncSandbox, ConfigFile, Secret diff --git a/koyeb/api/.openapi-generator/FILES b/koyeb/api/.openapi-generator/FILES index 686feaf1..df237aa5 100644 --- a/koyeb/api/.openapi-generator/FILES +++ b/koyeb/api/.openapi-generator/FILES @@ -38,6 +38,7 @@ koyeb/api/api/repositories_api.py koyeb/api/api/search_api.py koyeb/api/api/secrets_api.py koyeb/api/api/service_pools_api.py +koyeb/api/api/service_views_api.py koyeb/api/api/services_api.py koyeb/api/api/sessions_api.py koyeb/api/api/snapshots_api.py @@ -66,6 +67,7 @@ koyeb/api/docs/AppsSummary.md koyeb/api/docs/Archive.md koyeb/api/docs/ArchiveDeploymentMetadata.md koyeb/api/docs/ArchiveSource.md +koyeb/api/docs/ArchiveStatus.md koyeb/api/docs/ArchivesApi.md koyeb/api/docs/AutoRelease.md koyeb/api/docs/AutoReleaseGroup.md @@ -212,6 +214,7 @@ koyeb/api/docs/ExecCommandRequestTerminalSize.md koyeb/api/docs/GCPContainerRegistryConfiguration.md koyeb/api/docs/GRPCHealthCheck.md koyeb/api/docs/GetAppReply.md +koyeb/api/docs/GetArchiveReply.md koyeb/api/docs/GetBudgetReply.md koyeb/api/docs/GetCatalogInstanceReply.md koyeb/api/docs/GetCredentialReply.md @@ -288,6 +291,7 @@ koyeb/api/docs/KgitproxyListBranchesReply.md koyeb/api/docs/KgitproxyListRepositoriesReply.md koyeb/api/docs/KgitproxyRepository.md koyeb/api/docs/KgitproxyRepositoryProvider.md +koyeb/api/docs/KmetaGetOrganizationWorkspaceQuotasReply.md koyeb/api/docs/KsearchApp.md koyeb/api/docs/KsearchGlobalDeployment.md koyeb/api/docs/KsearchInstance.md @@ -301,6 +305,7 @@ koyeb/api/docs/KtestTestAuthRequest.md koyeb/api/docs/LifecycleQuotas.md koyeb/api/docs/ListAppEventsReply.md koyeb/api/docs/ListAppsReply.md +koyeb/api/docs/ListArchivesReply.md koyeb/api/docs/ListCatalogInstancesReply.md koyeb/api/docs/ListCredentialsReply.md koyeb/api/docs/ListDatacentersReply.md @@ -403,6 +408,11 @@ koyeb/api/docs/PublicOrganization.md koyeb/api/docs/PublicUser.md koyeb/api/docs/QueryLogsReply.md koyeb/api/docs/QueryLogsReplyPagination.md +koyeb/api/docs/QueryServicesViewFilters.md +koyeb/api/docs/QueryServicesViewReply.md +koyeb/api/docs/QueryServicesViewSort.md +koyeb/api/docs/QueryServicesViewSortDirection.md +koyeb/api/docs/QueryServicesViewSortField.md koyeb/api/docs/QuotaUsage.md koyeb/api/docs/Quotas.md koyeb/api/docs/QuotasApi.md @@ -455,6 +465,20 @@ koyeb/api/docs/ServiceStatus.md koyeb/api/docs/ServiceSummary.md koyeb/api/docs/ServiceType.md koyeb/api/docs/ServiceUsage.md +koyeb/api/docs/ServiceViewActiveDeployment.md +koyeb/api/docs/ServiceViewActiveDeploymentState.md +koyeb/api/docs/ServiceViewApp.md +koyeb/api/docs/ServiceViewFacet.md +koyeb/api/docs/ServiceViewFacetKind.md +koyeb/api/docs/ServiceViewFacetValue.md +koyeb/api/docs/ServiceViewGroup.md +koyeb/api/docs/ServiceViewGroupBy.md +koyeb/api/docs/ServiceViewLatestDeployment.md +koyeb/api/docs/ServiceViewLatestDeploymentState.md +koyeb/api/docs/ServiceViewRow.md +koyeb/api/docs/ServiceViewSource.md +koyeb/api/docs/ServiceViewSourceType.md +koyeb/api/docs/ServiceViewsApi.md koyeb/api/docs/ServicesApi.md koyeb/api/docs/SessionsApi.md koyeb/api/docs/Snapshot.md @@ -536,6 +560,7 @@ koyeb/api/models/apps_summary.py koyeb/api/models/archive.py koyeb/api/models/archive_deployment_metadata.py koyeb/api/models/archive_source.py +koyeb/api/models/archive_status.py koyeb/api/models/auto_release.py koyeb/api/models/auto_release_group.py koyeb/api/models/autocomplete_reply.py @@ -669,6 +694,7 @@ koyeb/api/models/exec_command_request_id_type.py koyeb/api/models/exec_command_request_terminal_size.py koyeb/api/models/gcp_container_registry_configuration.py koyeb/api/models/get_app_reply.py +koyeb/api/models/get_archive_reply.py koyeb/api/models/get_budget_reply.py koyeb/api/models/get_catalog_instance_reply.py koyeb/api/models/get_credential_reply.py @@ -742,6 +768,7 @@ koyeb/api/models/kgitproxy_list_branches_reply.py koyeb/api/models/kgitproxy_list_repositories_reply.py koyeb/api/models/kgitproxy_repository.py koyeb/api/models/kgitproxy_repository_provider.py +koyeb/api/models/kmeta_get_organization_workspace_quotas_reply.py koyeb/api/models/ksearch_app.py koyeb/api/models/ksearch_global_deployment.py koyeb/api/models/ksearch_instance.py @@ -755,6 +782,7 @@ koyeb/api/models/ktest_test_auth_request.py koyeb/api/models/lifecycle_quotas.py koyeb/api/models/list_app_events_reply.py koyeb/api/models/list_apps_reply.py +koyeb/api/models/list_archives_reply.py koyeb/api/models/list_catalog_instances_reply.py koyeb/api/models/list_credentials_reply.py koyeb/api/models/list_datacenters_reply.py @@ -844,6 +872,11 @@ koyeb/api/models/public_organization.py koyeb/api/models/public_user.py koyeb/api/models/query_logs_reply.py koyeb/api/models/query_logs_reply_pagination.py +koyeb/api/models/query_services_view_filters.py +koyeb/api/models/query_services_view_reply.py +koyeb/api/models/query_services_view_sort.py +koyeb/api/models/query_services_view_sort_direction.py +koyeb/api/models/query_services_view_sort_field.py koyeb/api/models/quota_usage.py koyeb/api/models/quotas.py koyeb/api/models/reactivate_organization_reply.py @@ -890,6 +923,19 @@ koyeb/api/models/service_status.py koyeb/api/models/service_summary.py koyeb/api/models/service_type.py koyeb/api/models/service_usage.py +koyeb/api/models/service_view_active_deployment.py +koyeb/api/models/service_view_active_deployment_state.py +koyeb/api/models/service_view_app.py +koyeb/api/models/service_view_facet.py +koyeb/api/models/service_view_facet_kind.py +koyeb/api/models/service_view_facet_value.py +koyeb/api/models/service_view_group.py +koyeb/api/models/service_view_group_by.py +koyeb/api/models/service_view_latest_deployment.py +koyeb/api/models/service_view_latest_deployment_state.py +koyeb/api/models/service_view_row.py +koyeb/api/models/service_view_source.py +koyeb/api/models/service_view_source_type.py koyeb/api/models/snapshot.py koyeb/api/models/snapshot_status.py koyeb/api/models/snapshot_type.py @@ -948,7 +994,27 @@ koyeb/api/models/verify_docker_image_reply.py koyeb/api/models/verify_docker_image_reply_err_code.py koyeb/api/rest.py koyeb/api/test/__init__.py -koyeb/api/test/test_docker_deployment_metadata.py -koyeb/api/test/test_grpc_health_check.py -koyeb/api/test/test_regional_deployment_metadata.py +koyeb/api/test/test_archive_status.py +koyeb/api/test/test_get_archive_reply.py +koyeb/api/test/test_kmeta_get_organization_workspace_quotas_reply.py +koyeb/api/test/test_list_archives_reply.py +koyeb/api/test/test_query_services_view_filters.py +koyeb/api/test/test_query_services_view_reply.py +koyeb/api/test/test_query_services_view_sort.py +koyeb/api/test/test_query_services_view_sort_direction.py +koyeb/api/test/test_query_services_view_sort_field.py +koyeb/api/test/test_service_view_active_deployment.py +koyeb/api/test/test_service_view_active_deployment_state.py +koyeb/api/test/test_service_view_app.py +koyeb/api/test/test_service_view_facet.py +koyeb/api/test/test_service_view_facet_kind.py +koyeb/api/test/test_service_view_facet_value.py +koyeb/api/test/test_service_view_group.py +koyeb/api/test/test_service_view_group_by.py +koyeb/api/test/test_service_view_latest_deployment.py +koyeb/api/test/test_service_view_latest_deployment_state.py +koyeb/api/test/test_service_view_row.py +koyeb/api/test/test_service_view_source.py +koyeb/api/test/test_service_view_source_type.py +koyeb/api/test/test_service_views_api.py koyeb/api_README.md diff --git a/koyeb/api/.openapi-generator/VERSION b/koyeb/api/.openapi-generator/VERSION index 56fe0e8b..84bf2cee 100644 --- a/koyeb/api/.openapi-generator/VERSION +++ b/koyeb/api/.openapi-generator/VERSION @@ -1 +1 @@ -7.27.0-SNAPSHOT +7.28.0-SNAPSHOT diff --git a/koyeb/api/__init__.py b/koyeb/api/__init__.py index dbdd8f3f..7921350b 100644 --- a/koyeb/api/__init__.py +++ b/koyeb/api/__init__.py @@ -5,7 +5,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -14,7 +14,7 @@ """ # noqa: E501 -__version__ = "1.6.1" +__version__ = "1.6.2" # Define package exports __all__ = [ @@ -51,6 +51,7 @@ "SearchApi", "SecretsApi", "ServicePoolsApi", + "ServiceViewsApi", "ServicesApi", "SessionsApi", "SnapshotsApi", @@ -87,6 +88,7 @@ "Archive", "ArchiveDeploymentMetadata", "ArchiveSource", + "ArchiveStatus", "AutoRelease", "AutoReleaseGroup", "AutocompleteReply", @@ -221,6 +223,7 @@ "GCPContainerRegistryConfiguration", "GRPCHealthCheck", "GetAppReply", + "GetArchiveReply", "GetBudgetReply", "GetCatalogInstanceReply", "GetCredentialReply", @@ -293,6 +296,7 @@ "KgitproxyListRepositoriesReply", "KgitproxyRepository", "KgitproxyRepositoryProvider", + "KmetaGetOrganizationWorkspaceQuotasReply", "KsearchApp", "KsearchGlobalDeployment", "KsearchInstance", @@ -306,6 +310,7 @@ "LifecycleQuotas", "ListAppEventsReply", "ListAppsReply", + "ListArchivesReply", "ListCatalogInstancesReply", "ListCredentialsReply", "ListDatacentersReply", @@ -395,6 +400,11 @@ "PublicUser", "QueryLogsReply", "QueryLogsReplyPagination", + "QueryServicesViewFilters", + "QueryServicesViewReply", + "QueryServicesViewSort", + "QueryServicesViewSortDirection", + "QueryServicesViewSortField", "QuotaUsage", "Quotas", "ReactivateOrganizationReply", @@ -441,6 +451,19 @@ "ServiceSummary", "ServiceType", "ServiceUsage", + "ServiceViewActiveDeployment", + "ServiceViewActiveDeploymentState", + "ServiceViewApp", + "ServiceViewFacet", + "ServiceViewFacetKind", + "ServiceViewFacetValue", + "ServiceViewGroup", + "ServiceViewGroupBy", + "ServiceViewLatestDeployment", + "ServiceViewLatestDeploymentState", + "ServiceViewRow", + "ServiceViewSource", + "ServiceViewSourceType", "Snapshot", "SnapshotStatus", "SnapshotType", @@ -553,6 +576,7 @@ from koyeb.api.api.search_api import SearchApi as SearchApi from koyeb.api.api.secrets_api import SecretsApi as SecretsApi from koyeb.api.api.service_pools_api import ServicePoolsApi as ServicePoolsApi +from koyeb.api.api.service_views_api import ServiceViewsApi as ServiceViewsApi from koyeb.api.api.services_api import ServicesApi as ServicesApi from koyeb.api.api.sessions_api import SessionsApi as SessionsApi from koyeb.api.api.snapshots_api import SnapshotsApi as SnapshotsApi @@ -597,6 +621,7 @@ ArchiveDeploymentMetadata as ArchiveDeploymentMetadata, ) from koyeb.api.models.archive_source import ArchiveSource as ArchiveSource +from koyeb.api.models.archive_status import ArchiveStatus as ArchiveStatus from koyeb.api.models.auto_release import AutoRelease as AutoRelease from koyeb.api.models.auto_release_group import AutoReleaseGroup as AutoReleaseGroup from koyeb.api.models.autocomplete_reply import AutocompleteReply as AutocompleteReply @@ -881,6 +906,7 @@ ) from koyeb.api.models.grpc_health_check import GRPCHealthCheck as GRPCHealthCheck from koyeb.api.models.get_app_reply import GetAppReply as GetAppReply +from koyeb.api.models.get_archive_reply import GetArchiveReply as GetArchiveReply from koyeb.api.models.get_budget_reply import GetBudgetReply as GetBudgetReply from koyeb.api.models.get_catalog_instance_reply import ( GetCatalogInstanceReply as GetCatalogInstanceReply, @@ -1045,6 +1071,9 @@ from koyeb.api.models.kgitproxy_repository_provider import ( KgitproxyRepositoryProvider as KgitproxyRepositoryProvider, ) +from koyeb.api.models.kmeta_get_organization_workspace_quotas_reply import ( + KmetaGetOrganizationWorkspaceQuotasReply as KmetaGetOrganizationWorkspaceQuotasReply, +) from koyeb.api.models.ksearch_app import KsearchApp as KsearchApp from koyeb.api.models.ksearch_global_deployment import ( KsearchGlobalDeployment as KsearchGlobalDeployment, @@ -1072,6 +1101,7 @@ ListAppEventsReply as ListAppEventsReply, ) from koyeb.api.models.list_apps_reply import ListAppsReply as ListAppsReply +from koyeb.api.models.list_archives_reply import ListArchivesReply as ListArchivesReply from koyeb.api.models.list_catalog_instances_reply import ( ListCatalogInstancesReply as ListCatalogInstancesReply, ) @@ -1269,6 +1299,21 @@ from koyeb.api.models.query_logs_reply_pagination import ( QueryLogsReplyPagination as QueryLogsReplyPagination, ) +from koyeb.api.models.query_services_view_filters import ( + QueryServicesViewFilters as QueryServicesViewFilters, +) +from koyeb.api.models.query_services_view_reply import ( + QueryServicesViewReply as QueryServicesViewReply, +) +from koyeb.api.models.query_services_view_sort import ( + QueryServicesViewSort as QueryServicesViewSort, +) +from koyeb.api.models.query_services_view_sort_direction import ( + QueryServicesViewSortDirection as QueryServicesViewSortDirection, +) +from koyeb.api.models.query_services_view_sort_field import ( + QueryServicesViewSortField as QueryServicesViewSortField, +) from koyeb.api.models.quota_usage import QuotaUsage as QuotaUsage from koyeb.api.models.quotas import Quotas as Quotas from koyeb.api.models.reactivate_organization_reply import ( @@ -1353,6 +1398,35 @@ from koyeb.api.models.service_summary import ServiceSummary as ServiceSummary from koyeb.api.models.service_type import ServiceType as ServiceType from koyeb.api.models.service_usage import ServiceUsage as ServiceUsage +from koyeb.api.models.service_view_active_deployment import ( + ServiceViewActiveDeployment as ServiceViewActiveDeployment, +) +from koyeb.api.models.service_view_active_deployment_state import ( + ServiceViewActiveDeploymentState as ServiceViewActiveDeploymentState, +) +from koyeb.api.models.service_view_app import ServiceViewApp as ServiceViewApp +from koyeb.api.models.service_view_facet import ServiceViewFacet as ServiceViewFacet +from koyeb.api.models.service_view_facet_kind import ( + ServiceViewFacetKind as ServiceViewFacetKind, +) +from koyeb.api.models.service_view_facet_value import ( + ServiceViewFacetValue as ServiceViewFacetValue, +) +from koyeb.api.models.service_view_group import ServiceViewGroup as ServiceViewGroup +from koyeb.api.models.service_view_group_by import ( + ServiceViewGroupBy as ServiceViewGroupBy, +) +from koyeb.api.models.service_view_latest_deployment import ( + ServiceViewLatestDeployment as ServiceViewLatestDeployment, +) +from koyeb.api.models.service_view_latest_deployment_state import ( + ServiceViewLatestDeploymentState as ServiceViewLatestDeploymentState, +) +from koyeb.api.models.service_view_row import ServiceViewRow as ServiceViewRow +from koyeb.api.models.service_view_source import ServiceViewSource as ServiceViewSource +from koyeb.api.models.service_view_source_type import ( + ServiceViewSourceType as ServiceViewSourceType, +) from koyeb.api.models.snapshot import Snapshot as Snapshot from koyeb.api.models.snapshot_status import SnapshotStatus as SnapshotStatus from koyeb.api.models.snapshot_type import SnapshotType as SnapshotType diff --git a/koyeb/api/api/__init__.py b/koyeb/api/api/__init__.py index 2088a1bc..9fa2108a 100644 --- a/koyeb/api/api/__init__.py +++ b/koyeb/api/api/__init__.py @@ -34,6 +34,7 @@ from koyeb.api.api.search_api import SearchApi from koyeb.api.api.secrets_api import SecretsApi from koyeb.api.api.service_pools_api import ServicePoolsApi +from koyeb.api.api.service_views_api import ServiceViewsApi from koyeb.api.api.services_api import ServicesApi from koyeb.api.api.sessions_api import SessionsApi from koyeb.api.api.snapshots_api import SnapshotsApi diff --git a/koyeb/api/api/activity_api.py b/koyeb/api/api/activity_api.py index efe6ed50..0ecc4858 100644 --- a/koyeb/api/api/activity_api.py +++ b/koyeb/api/api/activity_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/api/apps_api.py b/koyeb/api/api/apps_api.py index 6c29e665..9f0bd114 100644 --- a/koyeb/api/api/apps_api.py +++ b/koyeb/api/api/apps_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/api/archives_api.py b/koyeb/api/api/archives_api.py index 1d9c2f85..6dbca83c 100644 --- a/koyeb/api/api/archives_api.py +++ b/koyeb/api/api/archives_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -15,8 +15,13 @@ from typing import Any, Dict, List, Optional, Tuple, Union from typing_extensions import Annotated +from pydantic import Field, StrictStr, field_validator +from typing import Any, Dict, List, Optional +from typing_extensions import Annotated from koyeb.api.models.create_archive import CreateArchive from koyeb.api.models.create_archive_reply import CreateArchiveReply +from koyeb.api.models.get_archive_reply import GetArchiveReply +from koyeb.api.models.list_archives_reply import ListArchivesReply from koyeb.api.api_client import ApiClient, RequestSerialized from koyeb.api.api_response import ApiResponse @@ -294,3 +299,877 @@ def _create_archive_serialize( _host=_host, _request_auth=_request_auth, ) + + @validate_call + def delete_archive( + self, + id: Annotated[StrictStr, Field(description="The id of the archive.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> object: + """Delete Archive + + Mark an archive for deletion. Its status becomes deleting, and it is deleted along with its file shortly after. Deployments already built from it keep running, but nothing can be built from it any more. + + :param id: The id of the archive. (required) + :type id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_archive_serialize( + id=id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "object", + "400": "ErrorWithFields", + "401": "Error", + "403": "Error", + "404": "Error", + "500": "Error", + "503": "Error", + "default": "GoogleRpcStatus", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + @validate_call + def delete_archive_with_http_info( + self, + id: Annotated[StrictStr, Field(description="The id of the archive.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[object]: + """Delete Archive + + Mark an archive for deletion. Its status becomes deleting, and it is deleted along with its file shortly after. Deployments already built from it keep running, but nothing can be built from it any more. + + :param id: The id of the archive. (required) + :type id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_archive_serialize( + id=id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "object", + "400": "ErrorWithFields", + "401": "Error", + "403": "Error", + "404": "Error", + "500": "Error", + "503": "Error", + "default": "GoogleRpcStatus", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + @validate_call + def delete_archive_without_preload_content( + self, + id: Annotated[StrictStr, Field(description="The id of the archive.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete Archive + + Mark an archive for deletion. Its status becomes deleting, and it is deleted along with its file shortly after. Deployments already built from it keep running, but nothing can be built from it any more. + + :param id: The id of the archive. (required) + :type id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_archive_serialize( + id=id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "object", + "400": "ErrorWithFields", + "401": "Error", + "403": "Error", + "404": "Error", + "500": "Error", + "503": "Error", + "default": "GoogleRpcStatus", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + return response_data.response + + def _delete_archive_serialize( + self, + id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + _host = None + + _collection_formats: Dict[str, str] = {} + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Any] = self.api_client._merge_headers(_headers) + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params["id"] = id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + # set the HTTP header `Accept` + if not any(key.lower() == "accept" for key in _header_params): + _header_params["Accept"] = self.api_client.select_header_accept(["*/*"]) + + # authentication setting + _auth_settings: List[str] = ["Bearer"] + + return self.api_client.param_serialize( + method="DELETE", + resource_path="/v1/archives/{id}", + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth, + ) + + @validate_call + def get_archive( + self, + id: Annotated[StrictStr, Field(description="The id of the archive.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> GetArchiveReply: + """Get Archive + + Get an archive, with a signed URL to download it. + + :param id: The id of the archive. (required) + :type id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_archive_serialize( + id=id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "GetArchiveReply", + "400": "ErrorWithFields", + "401": "Error", + "403": "Error", + "404": "Error", + "500": "Error", + "503": "Error", + "default": "GoogleRpcStatus", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + @validate_call + def get_archive_with_http_info( + self, + id: Annotated[StrictStr, Field(description="The id of the archive.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[GetArchiveReply]: + """Get Archive + + Get an archive, with a signed URL to download it. + + :param id: The id of the archive. (required) + :type id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_archive_serialize( + id=id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "GetArchiveReply", + "400": "ErrorWithFields", + "401": "Error", + "403": "Error", + "404": "Error", + "500": "Error", + "503": "Error", + "default": "GoogleRpcStatus", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + @validate_call + def get_archive_without_preload_content( + self, + id: Annotated[StrictStr, Field(description="The id of the archive.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Archive + + Get an archive, with a signed URL to download it. + + :param id: The id of the archive. (required) + :type id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_archive_serialize( + id=id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "GetArchiveReply", + "400": "ErrorWithFields", + "401": "Error", + "403": "Error", + "404": "Error", + "500": "Error", + "503": "Error", + "default": "GoogleRpcStatus", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + return response_data.response + + def _get_archive_serialize( + self, + id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + _host = None + + _collection_formats: Dict[str, str] = {} + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Any] = self.api_client._merge_headers(_headers) + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params["id"] = id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + # set the HTTP header `Accept` + if not any(key.lower() == "accept" for key in _header_params): + _header_params["Accept"] = self.api_client.select_header_accept(["*/*"]) + + # authentication setting + _auth_settings: List[str] = ["Bearer"] + + return self.api_client.param_serialize( + method="GET", + resource_path="/v1/archives/{id}", + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth, + ) + + @validate_call + def list_archives( + self, + limit: Annotated[ + Optional[StrictStr], + Field(description="(Optional) The number of items to return"), + ] = None, + offset: Annotated[ + Optional[StrictStr], + Field(description="(Optional) The offset in the list of items to return"), + ] = None, + ids: Annotated[ + Optional[List[StrictStr]], + Field(description="(Optional) Filter on archive ids"), + ] = None, + statuses: Annotated[ + Optional[List[StrictStr]], + Field( + description="(Optional) Filter by archive status - ARCHIVE_STATUS_INVALID: zero value, invalid - ARCHIVE_STATUS_HEALTHY: the archive can be deployed and downloaded - ARCHIVE_STATUS_DELETING: the archive is waiting for its file to be removed - ARCHIVE_STATUS_DELETED: the archive and its file are deleted" + ), + ] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ListArchivesReply: + """List Archives + + List the archives of the organization, most recent first. + + :param limit: (Optional) The number of items to return + :type limit: str + :param offset: (Optional) The offset in the list of items to return + :type offset: str + :param ids: (Optional) Filter on archive ids + :type ids: List[str] + :param statuses: (Optional) Filter by archive status - ARCHIVE_STATUS_INVALID: zero value, invalid - ARCHIVE_STATUS_HEALTHY: the archive can be deployed and downloaded - ARCHIVE_STATUS_DELETING: the archive is waiting for its file to be removed - ARCHIVE_STATUS_DELETED: the archive and its file are deleted + :type statuses: List[str] + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_archives_serialize( + limit=limit, + offset=offset, + ids=ids, + statuses=statuses, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "ListArchivesReply", + "400": "ErrorWithFields", + "401": "Error", + "403": "Error", + "404": "Error", + "500": "Error", + "503": "Error", + "default": "GoogleRpcStatus", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + @validate_call + def list_archives_with_http_info( + self, + limit: Annotated[ + Optional[StrictStr], + Field(description="(Optional) The number of items to return"), + ] = None, + offset: Annotated[ + Optional[StrictStr], + Field(description="(Optional) The offset in the list of items to return"), + ] = None, + ids: Annotated[ + Optional[List[StrictStr]], + Field(description="(Optional) Filter on archive ids"), + ] = None, + statuses: Annotated[ + Optional[List[StrictStr]], + Field( + description="(Optional) Filter by archive status - ARCHIVE_STATUS_INVALID: zero value, invalid - ARCHIVE_STATUS_HEALTHY: the archive can be deployed and downloaded - ARCHIVE_STATUS_DELETING: the archive is waiting for its file to be removed - ARCHIVE_STATUS_DELETED: the archive and its file are deleted" + ), + ] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ListArchivesReply]: + """List Archives + + List the archives of the organization, most recent first. + + :param limit: (Optional) The number of items to return + :type limit: str + :param offset: (Optional) The offset in the list of items to return + :type offset: str + :param ids: (Optional) Filter on archive ids + :type ids: List[str] + :param statuses: (Optional) Filter by archive status - ARCHIVE_STATUS_INVALID: zero value, invalid - ARCHIVE_STATUS_HEALTHY: the archive can be deployed and downloaded - ARCHIVE_STATUS_DELETING: the archive is waiting for its file to be removed - ARCHIVE_STATUS_DELETED: the archive and its file are deleted + :type statuses: List[str] + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_archives_serialize( + limit=limit, + offset=offset, + ids=ids, + statuses=statuses, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "ListArchivesReply", + "400": "ErrorWithFields", + "401": "Error", + "403": "Error", + "404": "Error", + "500": "Error", + "503": "Error", + "default": "GoogleRpcStatus", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + @validate_call + def list_archives_without_preload_content( + self, + limit: Annotated[ + Optional[StrictStr], + Field(description="(Optional) The number of items to return"), + ] = None, + offset: Annotated[ + Optional[StrictStr], + Field(description="(Optional) The offset in the list of items to return"), + ] = None, + ids: Annotated[ + Optional[List[StrictStr]], + Field(description="(Optional) Filter on archive ids"), + ] = None, + statuses: Annotated[ + Optional[List[StrictStr]], + Field( + description="(Optional) Filter by archive status - ARCHIVE_STATUS_INVALID: zero value, invalid - ARCHIVE_STATUS_HEALTHY: the archive can be deployed and downloaded - ARCHIVE_STATUS_DELETING: the archive is waiting for its file to be removed - ARCHIVE_STATUS_DELETED: the archive and its file are deleted" + ), + ] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """List Archives + + List the archives of the organization, most recent first. + + :param limit: (Optional) The number of items to return + :type limit: str + :param offset: (Optional) The offset in the list of items to return + :type offset: str + :param ids: (Optional) Filter on archive ids + :type ids: List[str] + :param statuses: (Optional) Filter by archive status - ARCHIVE_STATUS_INVALID: zero value, invalid - ARCHIVE_STATUS_HEALTHY: the archive can be deployed and downloaded - ARCHIVE_STATUS_DELETING: the archive is waiting for its file to be removed - ARCHIVE_STATUS_DELETED: the archive and its file are deleted + :type statuses: List[str] + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_archives_serialize( + limit=limit, + offset=offset, + ids=ids, + statuses=statuses, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "ListArchivesReply", + "400": "ErrorWithFields", + "401": "Error", + "403": "Error", + "404": "Error", + "500": "Error", + "503": "Error", + "default": "GoogleRpcStatus", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + return response_data.response + + def _list_archives_serialize( + self, + limit, + offset, + ids, + statuses, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + _host = None + + _collection_formats: Dict[str, str] = { + "ids": "multi", + "statuses": "multi", + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Any] = self.api_client._merge_headers(_headers) + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if limit is not None: + _query_params.append(("limit", limit)) + + if offset is not None: + _query_params.append(("offset", offset)) + + if ids is not None: + _query_params.append(("ids", ids)) + + if statuses is not None: + _query_params.append(("statuses", statuses)) + + # process the header parameters + # process the form parameters + # process the body parameter + + # set the HTTP header `Accept` + if not any(key.lower() == "accept" for key in _header_params): + _header_params["Accept"] = self.api_client.select_header_accept(["*/*"]) + + # authentication setting + _auth_settings: List[str] = ["Bearer"] + + return self.api_client.param_serialize( + method="GET", + resource_path="/v1/archives", + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth, + ) diff --git a/koyeb/api/api/billing_api.py b/koyeb/api/api/billing_api.py index 68d8fe17..c8220b1e 100644 --- a/koyeb/api/api/billing_api.py +++ b/koyeb/api/api/billing_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/api/catalog_datacenters_api.py b/koyeb/api/api/catalog_datacenters_api.py index 02962c09..3ce7042c 100644 --- a/koyeb/api/api/catalog_datacenters_api.py +++ b/koyeb/api/api/catalog_datacenters_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/api/catalog_instance_usage_api.py b/koyeb/api/api/catalog_instance_usage_api.py index 5fdff673..e72efb28 100644 --- a/koyeb/api/api/catalog_instance_usage_api.py +++ b/koyeb/api/api/catalog_instance_usage_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/api/catalog_instances_api.py b/koyeb/api/api/catalog_instances_api.py index 652943df..360ad487 100644 --- a/koyeb/api/api/catalog_instances_api.py +++ b/koyeb/api/api/catalog_instances_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/api/catalog_regions_api.py b/koyeb/api/api/catalog_regions_api.py index 9ef8aa5a..c1366513 100644 --- a/koyeb/api/api/catalog_regions_api.py +++ b/koyeb/api/api/catalog_regions_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/api/compose_api.py b/koyeb/api/api/compose_api.py index 433d5a24..f9aef0c8 100644 --- a/koyeb/api/api/compose_api.py +++ b/koyeb/api/api/compose_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/api/coupons_api.py b/koyeb/api/api/coupons_api.py index 0b6302ec..9a582a92 100644 --- a/koyeb/api/api/coupons_api.py +++ b/koyeb/api/api/coupons_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/api/credentials_api.py b/koyeb/api/api/credentials_api.py index efd43d1c..8d602b99 100644 --- a/koyeb/api/api/credentials_api.py +++ b/koyeb/api/api/credentials_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/api/deployments_api.py b/koyeb/api/api/deployments_api.py index 07ae690b..6e42967a 100644 --- a/koyeb/api/api/deployments_api.py +++ b/koyeb/api/api/deployments_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/api/docker_helper_api.py b/koyeb/api/api/docker_helper_api.py index 113ffed9..931e085e 100644 --- a/koyeb/api/api/docker_helper_api.py +++ b/koyeb/api/api/docker_helper_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/api/domains_api.py b/koyeb/api/api/domains_api.py index 4ddae7a7..cdf16623 100644 --- a/koyeb/api/api/domains_api.py +++ b/koyeb/api/api/domains_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/api/instance_snapshots_api.py b/koyeb/api/api/instance_snapshots_api.py index facc928b..44e326b2 100644 --- a/koyeb/api/api/instance_snapshots_api.py +++ b/koyeb/api/api/instance_snapshots_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/api/instances_api.py b/koyeb/api/api/instances_api.py index 3f024064..6c948540 100644 --- a/koyeb/api/api/instances_api.py +++ b/koyeb/api/api/instances_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/api/intercom_api.py b/koyeb/api/api/intercom_api.py index fa362a8e..7c0d281d 100644 --- a/koyeb/api/api/intercom_api.py +++ b/koyeb/api/api/intercom_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/api/invite_api.py b/koyeb/api/api/invite_api.py index 92210414..3a3c7e32 100644 --- a/koyeb/api/api/invite_api.py +++ b/koyeb/api/api/invite_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/api/logs_api.py b/koyeb/api/api/logs_api.py index f11458c4..494552b7 100644 --- a/koyeb/api/api/logs_api.py +++ b/koyeb/api/api/logs_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/api/metrics_api.py b/koyeb/api/api/metrics_api.py index 50f6128e..bde06391 100644 --- a/koyeb/api/api/metrics_api.py +++ b/koyeb/api/api/metrics_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/api/organization_api.py b/koyeb/api/api/organization_api.py index 791bee88..b65001ac 100644 --- a/koyeb/api/api/organization_api.py +++ b/koyeb/api/api/organization_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/api/organization_confirmations_api.py b/koyeb/api/api/organization_confirmations_api.py index b0ea476b..73c3c17a 100644 --- a/koyeb/api/api/organization_confirmations_api.py +++ b/koyeb/api/api/organization_confirmations_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/api/organization_invitations_api.py b/koyeb/api/api/organization_invitations_api.py index a4d62bdd..0ff79286 100644 --- a/koyeb/api/api/organization_invitations_api.py +++ b/koyeb/api/api/organization_invitations_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/api/organization_members_api.py b/koyeb/api/api/organization_members_api.py index 8d31419f..0f51b93f 100644 --- a/koyeb/api/api/organization_members_api.py +++ b/koyeb/api/api/organization_members_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/api/organization_quotas_api.py b/koyeb/api/api/organization_quotas_api.py index ab320761..72adc32f 100644 --- a/koyeb/api/api/organization_quotas_api.py +++ b/koyeb/api/api/organization_quotas_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/api/payment_methods_api.py b/koyeb/api/api/payment_methods_api.py index 50a8e1c0..0b6b9dab 100644 --- a/koyeb/api/api/payment_methods_api.py +++ b/koyeb/api/api/payment_methods_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/api/persistent_volumes_api.py b/koyeb/api/api/persistent_volumes_api.py index cdcbb42e..38839d20 100644 --- a/koyeb/api/api/persistent_volumes_api.py +++ b/koyeb/api/api/persistent_volumes_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/api/pool_claims_api.py b/koyeb/api/api/pool_claims_api.py index d978fa5c..d9bd2a86 100644 --- a/koyeb/api/api/pool_claims_api.py +++ b/koyeb/api/api/pool_claims_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/api/profile_api.py b/koyeb/api/api/profile_api.py index 88e62988..88932766 100644 --- a/koyeb/api/api/profile_api.py +++ b/koyeb/api/api/profile_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/api/projects_api.py b/koyeb/api/api/projects_api.py index 283b10ae..93a3b2d4 100644 --- a/koyeb/api/api/projects_api.py +++ b/koyeb/api/api/projects_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/api/provisioning_api.py b/koyeb/api/api/provisioning_api.py index 80518bfb..ad6fc061 100644 --- a/koyeb/api/api/provisioning_api.py +++ b/koyeb/api/api/provisioning_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/api/quotas_api.py b/koyeb/api/api/quotas_api.py index a6d25de7..678c1f30 100644 --- a/koyeb/api/api/quotas_api.py +++ b/koyeb/api/api/quotas_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -19,6 +19,9 @@ from koyeb.api.models.get_organization_quotas_usage_reply import ( GetOrganizationQuotasUsageReply, ) +from koyeb.api.models.kmeta_get_organization_workspace_quotas_reply import ( + KmetaGetOrganizationWorkspaceQuotasReply, +) from koyeb.api.models.review_organization_capacity_reply import ( ReviewOrganizationCapacityReply, ) @@ -300,6 +303,260 @@ def _get_organization_quotas_usage_serialize( _request_auth=_request_auth, ) + @validate_call + def get_organization_workspace_quotas( + self, + organization_id: StrictStr, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> KmetaGetOrganizationWorkspaceQuotasReply: + """get_organization_workspace_quotas + + + :param organization_id: (required) + :type organization_id: str + :param workspace_id: (required) + :type workspace_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_organization_workspace_quotas_serialize( + organization_id=organization_id, + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "KmetaGetOrganizationWorkspaceQuotasReply", + "default": "GoogleRpcStatus", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + @validate_call + def get_organization_workspace_quotas_with_http_info( + self, + organization_id: StrictStr, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[KmetaGetOrganizationWorkspaceQuotasReply]: + """get_organization_workspace_quotas + + + :param organization_id: (required) + :type organization_id: str + :param workspace_id: (required) + :type workspace_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_organization_workspace_quotas_serialize( + organization_id=organization_id, + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "KmetaGetOrganizationWorkspaceQuotasReply", + "default": "GoogleRpcStatus", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + @validate_call + def get_organization_workspace_quotas_without_preload_content( + self, + organization_id: StrictStr, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """get_organization_workspace_quotas + + + :param organization_id: (required) + :type organization_id: str + :param workspace_id: (required) + :type workspace_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_organization_workspace_quotas_serialize( + organization_id=organization_id, + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "KmetaGetOrganizationWorkspaceQuotasReply", + "default": "GoogleRpcStatus", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + return response_data.response + + def _get_organization_workspace_quotas_serialize( + self, + organization_id, + workspace_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + _host = None + + _collection_formats: Dict[str, str] = {} + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Any] = self.api_client._merge_headers(_headers) + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if organization_id is not None: + _path_params["organization_id"] = organization_id + if workspace_id is not None: + _path_params["workspace_id"] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + # set the HTTP header `Accept` + if not any(key.lower() == "accept" for key in _header_params): + _header_params["Accept"] = self.api_client.select_header_accept(["*/*"]) + + # authentication setting + _auth_settings: List[str] = ["Bearer"] + + return self.api_client.param_serialize( + method="GET", + resource_path="/v1/quotas/organizations/{organization_id}/{workspace_id}/quotas", + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth, + ) + @validate_call def review_organization_capacity( self, diff --git a/koyeb/api/api/regional_deployments_api.py b/koyeb/api/api/regional_deployments_api.py index ebab3280..6183d0bd 100644 --- a/koyeb/api/api/regional_deployments_api.py +++ b/koyeb/api/api/regional_deployments_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/api/repositories_api.py b/koyeb/api/api/repositories_api.py index 1b62b673..25d10d63 100644 --- a/koyeb/api/api/repositories_api.py +++ b/koyeb/api/api/repositories_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/api/search_api.py b/koyeb/api/api/search_api.py index e6bcf420..524e7fb6 100644 --- a/koyeb/api/api/search_api.py +++ b/koyeb/api/api/search_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/api/secrets_api.py b/koyeb/api/api/secrets_api.py index 1438e0c8..461e9710 100644 --- a/koyeb/api/api/secrets_api.py +++ b/koyeb/api/api/secrets_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/api/service_pools_api.py b/koyeb/api/api/service_pools_api.py index 09f83cab..0e414984 100644 --- a/koyeb/api/api/service_pools_api.py +++ b/koyeb/api/api/service_pools_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -15,8 +15,9 @@ from typing import Any, Dict, List, Optional, Tuple, Union from typing_extensions import Annotated -from pydantic import StrictStr +from pydantic import Field, StrictStr from typing import Any, Dict, Optional +from typing_extensions import Annotated from koyeb.api.models.create_service_pool import CreateServicePool from koyeb.api.models.create_service_pool_reply import CreateServicePoolReply from koyeb.api.models.get_service_pool_reply import GetServicePoolReply @@ -818,7 +819,12 @@ def list_service_pools( name: Optional[StrictStr] = None, limit: Optional[StrictStr] = None, offset: Optional[StrictStr] = None, - status: Optional[StrictStr] = None, + status: Annotated[ + Optional[StrictStr], + Field( + description="Filter pools by their own status: ready, provisioning, error or deleting." + ), + ] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -900,7 +906,12 @@ def list_service_pools_with_http_info( name: Optional[StrictStr] = None, limit: Optional[StrictStr] = None, offset: Optional[StrictStr] = None, - status: Optional[StrictStr] = None, + status: Annotated[ + Optional[StrictStr], + Field( + description="Filter pools by their own status: ready, provisioning, error or deleting." + ), + ] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -982,7 +993,12 @@ def list_service_pools_without_preload_content( name: Optional[StrictStr] = None, limit: Optional[StrictStr] = None, offset: Optional[StrictStr] = None, - status: Optional[StrictStr] = None, + status: Annotated[ + Optional[StrictStr], + Field( + description="Filter pools by their own status: ready, provisioning, error or deleting." + ), + ] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], diff --git a/koyeb/api/api/service_views_api.py b/koyeb/api/api/service_views_api.py new file mode 100644 index 00000000..3502ea89 --- /dev/null +++ b/koyeb/api/api/service_views_api.py @@ -0,0 +1,642 @@ +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictBool, StrictStr, field_validator +from typing import List, Optional +from typing_extensions import Annotated +from koyeb.api.models.query_services_view_reply import QueryServicesViewReply + +from koyeb.api.api_client import ApiClient, RequestSerialized +from koyeb.api.api_response import ApiResponse +from koyeb.api.rest import RESTResponseType + + +class ServiceViewsApi: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + @validate_call + def query_services_view( + self, + search: Annotated[ + Optional[StrictStr], + Field( + description="(Optional) Case-insensitive search on the Service name and the App name" + ), + ] = None, + filters_types: Annotated[ + Optional[List[StrictStr]], + Field(description="(Optional) Filter on Service types"), + ] = None, + filters_statuses: Annotated[ + Optional[List[StrictStr]], + Field(description="(Optional) Filter on Service statuses"), + ] = None, + filters_regions: Annotated[ + Optional[List[StrictStr]], + Field(description="(Optional) Filter on regions of the latest Deployment"), + ] = None, + filters_app_ids: Annotated[ + Optional[List[StrictStr]], Field(description="(Optional) Filter on App ids") + ] = None, + filters_active_deployment_states: Annotated[ + Optional[List[StrictStr]], + Field( + description="(Optional) Filter on active Deployment states - SLEEPING: The active Deployment is scaled to zero and wakes up on traffic" + ), + ] = None, + filters_latest_deployment_states: Annotated[ + Optional[List[StrictStr]], + Field(description="(Optional) Filter on latest Deployment states"), + ] = None, + filters_needs_attention: Annotated[ + Optional[StrictBool], + Field(description="(Optional) Filter on Services that need attention"), + ] = None, + sort_field: Optional[StrictStr] = None, + sort_direction: Optional[StrictStr] = None, + group_by: Annotated[ + Optional[StrictStr], + Field( + description="(Optional) Group rows by App. Groups are ordered by App name and keep a stable order across pages. Pagination always counts Services" + ), + ] = None, + limit: Annotated[ + Optional[StrictStr], + Field(description="(Optional) The number of items to return"), + ] = None, + offset: Annotated[ + Optional[StrictStr], + Field(description="(Optional) The offset in the list of item to return"), + ] = None, + facets: Annotated[ + Optional[List[StrictStr]], + Field(description="(Optional) Facets to compute on the full result"), + ] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> QueryServicesViewReply: + """Query the Services view + + Unstable: this endpoint may change without notice. Returns Services with their App and Deployment state. Filters, search, sorting, grouping, counts and facets are all computed on the full authorized result before pagination. + + :param search: (Optional) Case-insensitive search on the Service name and the App name + :type search: str + :param filters_types: (Optional) Filter on Service types + :type filters_types: List[str] + :param filters_statuses: (Optional) Filter on Service statuses + :type filters_statuses: List[str] + :param filters_regions: (Optional) Filter on regions of the latest Deployment + :type filters_regions: List[str] + :param filters_app_ids: (Optional) Filter on App ids + :type filters_app_ids: List[str] + :param filters_active_deployment_states: (Optional) Filter on active Deployment states - SLEEPING: The active Deployment is scaled to zero and wakes up on traffic + :type filters_active_deployment_states: List[str] + :param filters_latest_deployment_states: (Optional) Filter on latest Deployment states + :type filters_latest_deployment_states: List[str] + :param filters_needs_attention: (Optional) Filter on Services that need attention + :type filters_needs_attention: bool + :param sort_field: + :type sort_field: str + :param sort_direction: + :type sort_direction: str + :param group_by: (Optional) Group rows by App. Groups are ordered by App name and keep a stable order across pages. Pagination always counts Services + :type group_by: str + :param limit: (Optional) The number of items to return + :type limit: str + :param offset: (Optional) The offset in the list of item to return + :type offset: str + :param facets: (Optional) Facets to compute on the full result + :type facets: List[str] + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._query_services_view_serialize( + search=search, + filters_types=filters_types, + filters_statuses=filters_statuses, + filters_regions=filters_regions, + filters_app_ids=filters_app_ids, + filters_active_deployment_states=filters_active_deployment_states, + filters_latest_deployment_states=filters_latest_deployment_states, + filters_needs_attention=filters_needs_attention, + sort_field=sort_field, + sort_direction=sort_direction, + group_by=group_by, + limit=limit, + offset=offset, + facets=facets, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "QueryServicesViewReply", + "400": "ErrorWithFields", + "401": "Error", + "403": "Error", + "404": "Error", + "500": "Error", + "503": "Error", + "default": "GoogleRpcStatus", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + @validate_call + def query_services_view_with_http_info( + self, + search: Annotated[ + Optional[StrictStr], + Field( + description="(Optional) Case-insensitive search on the Service name and the App name" + ), + ] = None, + filters_types: Annotated[ + Optional[List[StrictStr]], + Field(description="(Optional) Filter on Service types"), + ] = None, + filters_statuses: Annotated[ + Optional[List[StrictStr]], + Field(description="(Optional) Filter on Service statuses"), + ] = None, + filters_regions: Annotated[ + Optional[List[StrictStr]], + Field(description="(Optional) Filter on regions of the latest Deployment"), + ] = None, + filters_app_ids: Annotated[ + Optional[List[StrictStr]], Field(description="(Optional) Filter on App ids") + ] = None, + filters_active_deployment_states: Annotated[ + Optional[List[StrictStr]], + Field( + description="(Optional) Filter on active Deployment states - SLEEPING: The active Deployment is scaled to zero and wakes up on traffic" + ), + ] = None, + filters_latest_deployment_states: Annotated[ + Optional[List[StrictStr]], + Field(description="(Optional) Filter on latest Deployment states"), + ] = None, + filters_needs_attention: Annotated[ + Optional[StrictBool], + Field(description="(Optional) Filter on Services that need attention"), + ] = None, + sort_field: Optional[StrictStr] = None, + sort_direction: Optional[StrictStr] = None, + group_by: Annotated[ + Optional[StrictStr], + Field( + description="(Optional) Group rows by App. Groups are ordered by App name and keep a stable order across pages. Pagination always counts Services" + ), + ] = None, + limit: Annotated[ + Optional[StrictStr], + Field(description="(Optional) The number of items to return"), + ] = None, + offset: Annotated[ + Optional[StrictStr], + Field(description="(Optional) The offset in the list of item to return"), + ] = None, + facets: Annotated[ + Optional[List[StrictStr]], + Field(description="(Optional) Facets to compute on the full result"), + ] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[QueryServicesViewReply]: + """Query the Services view + + Unstable: this endpoint may change without notice. Returns Services with their App and Deployment state. Filters, search, sorting, grouping, counts and facets are all computed on the full authorized result before pagination. + + :param search: (Optional) Case-insensitive search on the Service name and the App name + :type search: str + :param filters_types: (Optional) Filter on Service types + :type filters_types: List[str] + :param filters_statuses: (Optional) Filter on Service statuses + :type filters_statuses: List[str] + :param filters_regions: (Optional) Filter on regions of the latest Deployment + :type filters_regions: List[str] + :param filters_app_ids: (Optional) Filter on App ids + :type filters_app_ids: List[str] + :param filters_active_deployment_states: (Optional) Filter on active Deployment states - SLEEPING: The active Deployment is scaled to zero and wakes up on traffic + :type filters_active_deployment_states: List[str] + :param filters_latest_deployment_states: (Optional) Filter on latest Deployment states + :type filters_latest_deployment_states: List[str] + :param filters_needs_attention: (Optional) Filter on Services that need attention + :type filters_needs_attention: bool + :param sort_field: + :type sort_field: str + :param sort_direction: + :type sort_direction: str + :param group_by: (Optional) Group rows by App. Groups are ordered by App name and keep a stable order across pages. Pagination always counts Services + :type group_by: str + :param limit: (Optional) The number of items to return + :type limit: str + :param offset: (Optional) The offset in the list of item to return + :type offset: str + :param facets: (Optional) Facets to compute on the full result + :type facets: List[str] + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._query_services_view_serialize( + search=search, + filters_types=filters_types, + filters_statuses=filters_statuses, + filters_regions=filters_regions, + filters_app_ids=filters_app_ids, + filters_active_deployment_states=filters_active_deployment_states, + filters_latest_deployment_states=filters_latest_deployment_states, + filters_needs_attention=filters_needs_attention, + sort_field=sort_field, + sort_direction=sort_direction, + group_by=group_by, + limit=limit, + offset=offset, + facets=facets, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "QueryServicesViewReply", + "400": "ErrorWithFields", + "401": "Error", + "403": "Error", + "404": "Error", + "500": "Error", + "503": "Error", + "default": "GoogleRpcStatus", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + @validate_call + def query_services_view_without_preload_content( + self, + search: Annotated[ + Optional[StrictStr], + Field( + description="(Optional) Case-insensitive search on the Service name and the App name" + ), + ] = None, + filters_types: Annotated[ + Optional[List[StrictStr]], + Field(description="(Optional) Filter on Service types"), + ] = None, + filters_statuses: Annotated[ + Optional[List[StrictStr]], + Field(description="(Optional) Filter on Service statuses"), + ] = None, + filters_regions: Annotated[ + Optional[List[StrictStr]], + Field(description="(Optional) Filter on regions of the latest Deployment"), + ] = None, + filters_app_ids: Annotated[ + Optional[List[StrictStr]], Field(description="(Optional) Filter on App ids") + ] = None, + filters_active_deployment_states: Annotated[ + Optional[List[StrictStr]], + Field( + description="(Optional) Filter on active Deployment states - SLEEPING: The active Deployment is scaled to zero and wakes up on traffic" + ), + ] = None, + filters_latest_deployment_states: Annotated[ + Optional[List[StrictStr]], + Field(description="(Optional) Filter on latest Deployment states"), + ] = None, + filters_needs_attention: Annotated[ + Optional[StrictBool], + Field(description="(Optional) Filter on Services that need attention"), + ] = None, + sort_field: Optional[StrictStr] = None, + sort_direction: Optional[StrictStr] = None, + group_by: Annotated[ + Optional[StrictStr], + Field( + description="(Optional) Group rows by App. Groups are ordered by App name and keep a stable order across pages. Pagination always counts Services" + ), + ] = None, + limit: Annotated[ + Optional[StrictStr], + Field(description="(Optional) The number of items to return"), + ] = None, + offset: Annotated[ + Optional[StrictStr], + Field(description="(Optional) The offset in the list of item to return"), + ] = None, + facets: Annotated[ + Optional[List[StrictStr]], + Field(description="(Optional) Facets to compute on the full result"), + ] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Query the Services view + + Unstable: this endpoint may change without notice. Returns Services with their App and Deployment state. Filters, search, sorting, grouping, counts and facets are all computed on the full authorized result before pagination. + + :param search: (Optional) Case-insensitive search on the Service name and the App name + :type search: str + :param filters_types: (Optional) Filter on Service types + :type filters_types: List[str] + :param filters_statuses: (Optional) Filter on Service statuses + :type filters_statuses: List[str] + :param filters_regions: (Optional) Filter on regions of the latest Deployment + :type filters_regions: List[str] + :param filters_app_ids: (Optional) Filter on App ids + :type filters_app_ids: List[str] + :param filters_active_deployment_states: (Optional) Filter on active Deployment states - SLEEPING: The active Deployment is scaled to zero and wakes up on traffic + :type filters_active_deployment_states: List[str] + :param filters_latest_deployment_states: (Optional) Filter on latest Deployment states + :type filters_latest_deployment_states: List[str] + :param filters_needs_attention: (Optional) Filter on Services that need attention + :type filters_needs_attention: bool + :param sort_field: + :type sort_field: str + :param sort_direction: + :type sort_direction: str + :param group_by: (Optional) Group rows by App. Groups are ordered by App name and keep a stable order across pages. Pagination always counts Services + :type group_by: str + :param limit: (Optional) The number of items to return + :type limit: str + :param offset: (Optional) The offset in the list of item to return + :type offset: str + :param facets: (Optional) Facets to compute on the full result + :type facets: List[str] + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._query_services_view_serialize( + search=search, + filters_types=filters_types, + filters_statuses=filters_statuses, + filters_regions=filters_regions, + filters_app_ids=filters_app_ids, + filters_active_deployment_states=filters_active_deployment_states, + filters_latest_deployment_states=filters_latest_deployment_states, + filters_needs_attention=filters_needs_attention, + sort_field=sort_field, + sort_direction=sort_direction, + group_by=group_by, + limit=limit, + offset=offset, + facets=facets, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "QueryServicesViewReply", + "400": "ErrorWithFields", + "401": "Error", + "403": "Error", + "404": "Error", + "500": "Error", + "503": "Error", + "default": "GoogleRpcStatus", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + return response_data.response + + def _query_services_view_serialize( + self, + search, + filters_types, + filters_statuses, + filters_regions, + filters_app_ids, + filters_active_deployment_states, + filters_latest_deployment_states, + filters_needs_attention, + sort_field, + sort_direction, + group_by, + limit, + offset, + facets, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + _host = None + + _collection_formats: Dict[str, str] = { + "filters.types": "multi", + "filters.statuses": "multi", + "filters.regions": "multi", + "filters.app_ids": "multi", + "filters.active_deployment_states": "multi", + "filters.latest_deployment_states": "multi", + "facets": "multi", + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Any] = self.api_client._merge_headers(_headers) + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if search is not None: + _query_params.append(("search", search)) + + if filters_types is not None: + _query_params.append(("filters.types", filters_types)) + + if filters_statuses is not None: + _query_params.append(("filters.statuses", filters_statuses)) + + if filters_regions is not None: + _query_params.append(("filters.regions", filters_regions)) + + if filters_app_ids is not None: + _query_params.append(("filters.app_ids", filters_app_ids)) + + if filters_active_deployment_states is not None: + _query_params.append( + ("filters.active_deployment_states", filters_active_deployment_states) + ) + + if filters_latest_deployment_states is not None: + _query_params.append( + ("filters.latest_deployment_states", filters_latest_deployment_states) + ) + + if filters_needs_attention is not None: + _query_params.append(("filters.needs_attention", filters_needs_attention)) + + if sort_field is not None: + _query_params.append(("sort.field", sort_field)) + + if sort_direction is not None: + _query_params.append(("sort.direction", sort_direction)) + + if group_by is not None: + _query_params.append(("group_by", group_by)) + + if limit is not None: + _query_params.append(("limit", limit)) + + if offset is not None: + _query_params.append(("offset", offset)) + + if facets is not None: + _query_params.append(("facets", facets)) + + # process the header parameters + # process the form parameters + # process the body parameter + + # set the HTTP header `Accept` + if not any(key.lower() == "accept" for key in _header_params): + _header_params["Accept"] = self.api_client.select_header_accept(["*/*"]) + + # authentication setting + _auth_settings: List[str] = ["Bearer"] + + return self.api_client.param_serialize( + method="GET", + resource_path="/v1/views/services", + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth, + ) diff --git a/koyeb/api/api/services_api.py b/koyeb/api/api/services_api.py index 6eac732b..0b19aeee 100644 --- a/koyeb/api/api/services_api.py +++ b/koyeb/api/api/services_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/api/sessions_api.py b/koyeb/api/api/sessions_api.py index b9f98d09..aae8e330 100644 --- a/koyeb/api/api/sessions_api.py +++ b/koyeb/api/api/sessions_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/api/snapshots_api.py b/koyeb/api/api/snapshots_api.py index 48ff8e06..8e00cbe8 100644 --- a/koyeb/api/api/snapshots_api.py +++ b/koyeb/api/api/snapshots_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -832,7 +832,7 @@ def list_snapshots( statuses: Annotated[ Optional[List[StrictStr]], Field( - description="(Optional) Filter by status - SNAPSHOT_STATUS_INVALID: zero value, invalid - SNAPSHOT_STATUS_CREATING: the snapshot is being created - SNAPSHOT_STATUS_AVAILABLE: the snapshot is complete and available - SNAPSHOT_STATUS_MIGRATING: the snapshot is being migrated - SNAPSHOT_STATUS_DELETING: the snapshot is being deleted - SNAPSHOT_STATUS_DELETED: the snapshot is deleted" + description="(Optional) Filter by status - SNAPSHOT_STATUS_INVALID: zero value, invalid - SNAPSHOT_STATUS_CREATING: the snapshot is being created - SNAPSHOT_STATUS_AVAILABLE: the snapshot is complete and available - SNAPSHOT_STATUS_MIGRATING: the snapshot is being migrated - SNAPSHOT_STATUS_DELETING: the snapshot is being deleted - SNAPSHOT_STATUS_DELETED: the snapshot is deleted - SNAPSHOT_STATUS_ERROR: the snapshot could not be created" ), ] = None, region: Annotated[ @@ -863,7 +863,7 @@ def list_snapshots( :type offset: str :param organization_id: (Optional) Filter by organization_id :type organization_id: str - :param statuses: (Optional) Filter by status - SNAPSHOT_STATUS_INVALID: zero value, invalid - SNAPSHOT_STATUS_CREATING: the snapshot is being created - SNAPSHOT_STATUS_AVAILABLE: the snapshot is complete and available - SNAPSHOT_STATUS_MIGRATING: the snapshot is being migrated - SNAPSHOT_STATUS_DELETING: the snapshot is being deleted - SNAPSHOT_STATUS_DELETED: the snapshot is deleted + :param statuses: (Optional) Filter by status - SNAPSHOT_STATUS_INVALID: zero value, invalid - SNAPSHOT_STATUS_CREATING: the snapshot is being created - SNAPSHOT_STATUS_AVAILABLE: the snapshot is complete and available - SNAPSHOT_STATUS_MIGRATING: the snapshot is being migrated - SNAPSHOT_STATUS_DELETING: the snapshot is being deleted - SNAPSHOT_STATUS_DELETED: the snapshot is deleted - SNAPSHOT_STATUS_ERROR: the snapshot could not be created :type statuses: List[str] :param region: (Optional) A filter for the region :type region: str @@ -941,7 +941,7 @@ def list_snapshots_with_http_info( statuses: Annotated[ Optional[List[StrictStr]], Field( - description="(Optional) Filter by status - SNAPSHOT_STATUS_INVALID: zero value, invalid - SNAPSHOT_STATUS_CREATING: the snapshot is being created - SNAPSHOT_STATUS_AVAILABLE: the snapshot is complete and available - SNAPSHOT_STATUS_MIGRATING: the snapshot is being migrated - SNAPSHOT_STATUS_DELETING: the snapshot is being deleted - SNAPSHOT_STATUS_DELETED: the snapshot is deleted" + description="(Optional) Filter by status - SNAPSHOT_STATUS_INVALID: zero value, invalid - SNAPSHOT_STATUS_CREATING: the snapshot is being created - SNAPSHOT_STATUS_AVAILABLE: the snapshot is complete and available - SNAPSHOT_STATUS_MIGRATING: the snapshot is being migrated - SNAPSHOT_STATUS_DELETING: the snapshot is being deleted - SNAPSHOT_STATUS_DELETED: the snapshot is deleted - SNAPSHOT_STATUS_ERROR: the snapshot could not be created" ), ] = None, region: Annotated[ @@ -972,7 +972,7 @@ def list_snapshots_with_http_info( :type offset: str :param organization_id: (Optional) Filter by organization_id :type organization_id: str - :param statuses: (Optional) Filter by status - SNAPSHOT_STATUS_INVALID: zero value, invalid - SNAPSHOT_STATUS_CREATING: the snapshot is being created - SNAPSHOT_STATUS_AVAILABLE: the snapshot is complete and available - SNAPSHOT_STATUS_MIGRATING: the snapshot is being migrated - SNAPSHOT_STATUS_DELETING: the snapshot is being deleted - SNAPSHOT_STATUS_DELETED: the snapshot is deleted + :param statuses: (Optional) Filter by status - SNAPSHOT_STATUS_INVALID: zero value, invalid - SNAPSHOT_STATUS_CREATING: the snapshot is being created - SNAPSHOT_STATUS_AVAILABLE: the snapshot is complete and available - SNAPSHOT_STATUS_MIGRATING: the snapshot is being migrated - SNAPSHOT_STATUS_DELETING: the snapshot is being deleted - SNAPSHOT_STATUS_DELETED: the snapshot is deleted - SNAPSHOT_STATUS_ERROR: the snapshot could not be created :type statuses: List[str] :param region: (Optional) A filter for the region :type region: str @@ -1050,7 +1050,7 @@ def list_snapshots_without_preload_content( statuses: Annotated[ Optional[List[StrictStr]], Field( - description="(Optional) Filter by status - SNAPSHOT_STATUS_INVALID: zero value, invalid - SNAPSHOT_STATUS_CREATING: the snapshot is being created - SNAPSHOT_STATUS_AVAILABLE: the snapshot is complete and available - SNAPSHOT_STATUS_MIGRATING: the snapshot is being migrated - SNAPSHOT_STATUS_DELETING: the snapshot is being deleted - SNAPSHOT_STATUS_DELETED: the snapshot is deleted" + description="(Optional) Filter by status - SNAPSHOT_STATUS_INVALID: zero value, invalid - SNAPSHOT_STATUS_CREATING: the snapshot is being created - SNAPSHOT_STATUS_AVAILABLE: the snapshot is complete and available - SNAPSHOT_STATUS_MIGRATING: the snapshot is being migrated - SNAPSHOT_STATUS_DELETING: the snapshot is being deleted - SNAPSHOT_STATUS_DELETED: the snapshot is deleted - SNAPSHOT_STATUS_ERROR: the snapshot could not be created" ), ] = None, region: Annotated[ @@ -1081,7 +1081,7 @@ def list_snapshots_without_preload_content( :type offset: str :param organization_id: (Optional) Filter by organization_id :type organization_id: str - :param statuses: (Optional) Filter by status - SNAPSHOT_STATUS_INVALID: zero value, invalid - SNAPSHOT_STATUS_CREATING: the snapshot is being created - SNAPSHOT_STATUS_AVAILABLE: the snapshot is complete and available - SNAPSHOT_STATUS_MIGRATING: the snapshot is being migrated - SNAPSHOT_STATUS_DELETING: the snapshot is being deleted - SNAPSHOT_STATUS_DELETED: the snapshot is deleted + :param statuses: (Optional) Filter by status - SNAPSHOT_STATUS_INVALID: zero value, invalid - SNAPSHOT_STATUS_CREATING: the snapshot is being created - SNAPSHOT_STATUS_AVAILABLE: the snapshot is complete and available - SNAPSHOT_STATUS_MIGRATING: the snapshot is being migrated - SNAPSHOT_STATUS_DELETING: the snapshot is being deleted - SNAPSHOT_STATUS_DELETED: the snapshot is deleted - SNAPSHOT_STATUS_ERROR: the snapshot could not be created :type statuses: List[str] :param region: (Optional) A filter for the region :type region: str diff --git a/koyeb/api/api/sso_api.py b/koyeb/api/api/sso_api.py index 956a2a68..9d8f3a3d 100644 --- a/koyeb/api/api/sso_api.py +++ b/koyeb/api/api/sso_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/api/subscriptions_api.py b/koyeb/api/api/subscriptions_api.py index 3cd8de8d..53565e55 100644 --- a/koyeb/api/api/subscriptions_api.py +++ b/koyeb/api/api/subscriptions_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/api/summary_api.py b/koyeb/api/api/summary_api.py index f48108aa..90fa3f39 100644 --- a/koyeb/api/api/summary_api.py +++ b/koyeb/api/api/summary_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/api/test_api.py b/koyeb/api/api/test_api.py index 3b2a6775..cebe5c0f 100644 --- a/koyeb/api/api/test_api.py +++ b/koyeb/api/api/test_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/api/usages_api.py b/koyeb/api/api/usages_api.py index 2854675d..602949b3 100644 --- a/koyeb/api/api/usages_api.py +++ b/koyeb/api/api/usages_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/api/users_api.py b/koyeb/api/api/users_api.py index f1066bff..3da805be 100644 --- a/koyeb/api/api/users_api.py +++ b/koyeb/api/api/users_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/api_client.py b/koyeb/api/api_client.py index 9513d8ba..6391e24d 100644 --- a/koyeb/api/api_client.py +++ b/koyeb/api/api_client.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -87,7 +87,7 @@ def __init__( self.default_headers[header_name] = header_value self.cookie = cookie # Set default User-Agent. - self.user_agent = "OpenAPI-Generator/1.6.1/python" + self.user_agent = "OpenAPI-Generator/1.6.2/python" self.client_side_validation = configuration.client_side_validation def __enter__(self): diff --git a/koyeb/api/configuration.py b/koyeb/api/configuration.py index d351bde7..20e1c2d8 100644 --- a/koyeb/api/configuration.py +++ b/koyeb/api/configuration.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -600,7 +600,7 @@ def to_debug_report(self) -> str: "OS: {env}\n" "Python Version: {pyversion}\n" "Version of the API: 1.0.0\n" - "SDK Package Version: 1.6.1".format(env=sys.platform, pyversion=sys.version) + "SDK Package Version: 1.6.2".format(env=sys.platform, pyversion=sys.version) ) def get_host_settings(self) -> List[HostSetting]: diff --git a/koyeb/api/docs/AppLifeCycle.md b/koyeb/api/docs/AppLifeCycle.md index 3d7bbb1c..fecd25fb 100644 --- a/koyeb/api/docs/AppLifeCycle.md +++ b/koyeb/api/docs/AppLifeCycle.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**delete_when_empty** | **bool** | | [optional] +**delete_when_empty** | **bool** | If true, the app is deleted once it has no service left: either when its last service is deleted or, for an app that never had a service, once it is older than 15 minutes. | [optional] ## Example diff --git a/koyeb/api/docs/Archive.md b/koyeb/api/docs/Archive.md index 8b162e71..4c041781 100644 --- a/koyeb/api/docs/Archive.md +++ b/koyeb/api/docs/Archive.md @@ -11,6 +11,9 @@ Name | Type | Description | Notes **size** | **str** | The provisioned space for the archive. | [optional] **created_at** | **datetime** | Date of creation of the archive. | [optional] **deleted_at** | **datetime** | This field is automatically set by Koyeb when the archive is garbage collected. | [optional] +**download_url** | **str** | A signed URL to download the archive. Getting an archive signs a new one when it has less than 5 minutes left, valid for 24 hours. | [optional] +**download_url_deadline** | **datetime** | When download_url expires. | [optional] +**status** | [**ArchiveStatus**](ArchiveStatus.md) | | [optional] [default to ArchiveStatus.ARCHIVE_STATUS_INVALID] ## Example diff --git a/koyeb/api/docs/ArchiveStatus.md b/koyeb/api/docs/ArchiveStatus.md new file mode 100644 index 00000000..c07a3405 --- /dev/null +++ b/koyeb/api/docs/ArchiveStatus.md @@ -0,0 +1,16 @@ +# ArchiveStatus + + +## Enum + +* `ARCHIVE_STATUS_INVALID` (value: `'ARCHIVE_STATUS_INVALID'`) + +* `ARCHIVE_STATUS_HEALTHY` (value: `'ARCHIVE_STATUS_HEALTHY'`) + +* `ARCHIVE_STATUS_DELETING` (value: `'ARCHIVE_STATUS_DELETING'`) + +* `ARCHIVE_STATUS_DELETED` (value: `'ARCHIVE_STATUS_DELETED'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/koyeb/api/docs/ArchivesApi.md b/koyeb/api/docs/ArchivesApi.md index c03b9f93..73b7385a 100644 --- a/koyeb/api/docs/ArchivesApi.md +++ b/koyeb/api/docs/ArchivesApi.md @@ -5,6 +5,9 @@ All URIs are relative to *https://app.koyeb.com* Method | HTTP request | Description ------------- | ------------- | ------------- [**create_archive**](ArchivesApi.md#create_archive) | **POST** /v1/archives | Create Archive +[**delete_archive**](ArchivesApi.md#delete_archive) | **DELETE** /v1/archives/{id} | Delete Archive +[**get_archive**](ArchivesApi.md#get_archive) | **GET** /v1/archives/{id} | Get Archive +[**list_archives**](ArchivesApi.md#list_archives) | **GET** /v1/archives | List Archives # **create_archive** @@ -94,3 +97,268 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **delete_archive** +> object delete_archive(id) + +Delete Archive + +Mark an archive for deletion. Its status becomes deleting, and it is +deleted along with its file shortly after. Deployments already built from +it keep running, but nothing can be built from it any more. + +### Example + +* Api Key Authentication (Bearer): + +```python +import koyeb.api +from koyeb.api.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://app.koyeb.com +# See configuration.py for a list of all supported configuration parameters. +configuration = koyeb.api.Configuration( + host = "https://app.koyeb.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: Bearer +configuration.api_key['Bearer'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Bearer'] = 'Bearer' + +# Enter a context with an instance of the API client +with koyeb.api.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = koyeb.api.ArchivesApi(api_client) + id = 'id_example' # str | The id of the archive. + + try: + # Delete Archive + api_response = api_instance.delete_archive(id) + print("The response of ArchivesApi->delete_archive:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ArchivesApi->delete_archive: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| The id of the archive. | + +### Return type + +**object** + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | A successful response. | - | +**400** | Validation error | - | +**401** | Returned when the token is not valid. | - | +**403** | Returned when the user does not have permission to access the resource. | - | +**404** | Returned when the resource does not exist. | - | +**500** | Returned in case of server error. | - | +**503** | Service is unavailable. | - | +**0** | An unexpected error response. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_archive** +> GetArchiveReply get_archive(id) + +Get Archive + +Get an archive, with a signed URL to download it. + +### Example + +* Api Key Authentication (Bearer): + +```python +import koyeb.api +from koyeb.api.models.get_archive_reply import GetArchiveReply +from koyeb.api.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://app.koyeb.com +# See configuration.py for a list of all supported configuration parameters. +configuration = koyeb.api.Configuration( + host = "https://app.koyeb.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: Bearer +configuration.api_key['Bearer'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Bearer'] = 'Bearer' + +# Enter a context with an instance of the API client +with koyeb.api.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = koyeb.api.ArchivesApi(api_client) + id = 'id_example' # str | The id of the archive. + + try: + # Get Archive + api_response = api_instance.get_archive(id) + print("The response of ArchivesApi->get_archive:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ArchivesApi->get_archive: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| The id of the archive. | + +### Return type + +[**GetArchiveReply**](GetArchiveReply.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | A successful response. | - | +**400** | Validation error | - | +**401** | Returned when the token is not valid. | - | +**403** | Returned when the user does not have permission to access the resource. | - | +**404** | Returned when the resource does not exist. | - | +**500** | Returned in case of server error. | - | +**503** | Service is unavailable. | - | +**0** | An unexpected error response. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **list_archives** +> ListArchivesReply list_archives(limit=limit, offset=offset, ids=ids, statuses=statuses) + +List Archives + +List the archives of the organization, most recent first. + +### Example + +* Api Key Authentication (Bearer): + +```python +import koyeb.api +from koyeb.api.models.list_archives_reply import ListArchivesReply +from koyeb.api.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://app.koyeb.com +# See configuration.py for a list of all supported configuration parameters. +configuration = koyeb.api.Configuration( + host = "https://app.koyeb.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: Bearer +configuration.api_key['Bearer'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Bearer'] = 'Bearer' + +# Enter a context with an instance of the API client +with koyeb.api.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = koyeb.api.ArchivesApi(api_client) + limit = 'limit_example' # str | (Optional) The number of items to return (optional) + offset = 'offset_example' # str | (Optional) The offset in the list of items to return (optional) + ids = ['ids_example'] # List[str] | (Optional) Filter on archive ids (optional) + statuses = ['statuses_example'] # List[str] | (Optional) Filter by archive status - ARCHIVE_STATUS_INVALID: zero value, invalid - ARCHIVE_STATUS_HEALTHY: the archive can be deployed and downloaded - ARCHIVE_STATUS_DELETING: the archive is waiting for its file to be removed - ARCHIVE_STATUS_DELETED: the archive and its file are deleted (optional) + + try: + # List Archives + api_response = api_instance.list_archives(limit=limit, offset=offset, ids=ids, statuses=statuses) + print("The response of ArchivesApi->list_archives:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ArchivesApi->list_archives: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **limit** | **str**| (Optional) The number of items to return | [optional] + **offset** | **str**| (Optional) The offset in the list of items to return | [optional] + **ids** | [**List[str]**](str.md)| (Optional) Filter on archive ids | [optional] + **statuses** | [**List[str]**](str.md)| (Optional) Filter by archive status - ARCHIVE_STATUS_INVALID: zero value, invalid - ARCHIVE_STATUS_HEALTHY: the archive can be deployed and downloaded - ARCHIVE_STATUS_DELETING: the archive is waiting for its file to be removed - ARCHIVE_STATUS_DELETED: the archive and its file are deleted | [optional] + +### Return type + +[**ListArchivesReply**](ListArchivesReply.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | A successful response. | - | +**400** | Validation error | - | +**401** | Returned when the token is not valid. | - | +**403** | Returned when the user does not have permission to access the resource. | - | +**404** | Returned when the resource does not exist. | - | +**500** | Returned in case of server error. | - | +**503** | Service is unavailable. | - | +**0** | An unexpected error response. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/koyeb/api/docs/DeploymentDefinition.md b/koyeb/api/docs/DeploymentDefinition.md index dadeda09..2f1fa0dd 100644 --- a/koyeb/api/docs/DeploymentDefinition.md +++ b/koyeb/api/docs/DeploymentDefinition.md @@ -21,6 +21,7 @@ Name | Type | Description | Notes **skip_cache** | **bool** | | [optional] **mesh** | [**DeploymentMesh**](DeploymentMesh.md) | | [optional] [default to DeploymentMesh.DEPLOYMENT_MESH_AUTO] **network_policy** | [**NetworkPolicy**](NetworkPolicy.md) | | [optional] +**kill_timeout_secs** | **int** | | [optional] **docker** | [**DockerSource**](DockerSource.md) | | [optional] **git** | [**GitSource**](GitSource.md) | | [optional] **database** | [**DatabaseSource**](DatabaseSource.md) | | [optional] diff --git a/koyeb/api/docs/GetArchiveReply.md b/koyeb/api/docs/GetArchiveReply.md new file mode 100644 index 00000000..b6352ad4 --- /dev/null +++ b/koyeb/api/docs/GetArchiveReply.md @@ -0,0 +1,29 @@ +# GetArchiveReply + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**archive** | [**Archive**](Archive.md) | | [optional] + +## Example + +```python +from koyeb.api.models.get_archive_reply import GetArchiveReply + +# TODO update the JSON string below +json = "{}" +# create an instance of GetArchiveReply from a JSON string +get_archive_reply_instance = GetArchiveReply.from_json(json) +# print the JSON string representation of the object +print(GetArchiveReply.to_json()) + +# convert the object into a dict +get_archive_reply_dict = get_archive_reply_instance.to_dict() +# create an instance of GetArchiveReply from a dict +get_archive_reply_from_dict = GetArchiveReply.from_dict(get_archive_reply_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/koyeb/api/docs/GitSource.md b/koyeb/api/docs/GitSource.md index af37c8c5..edf91cb4 100644 --- a/koyeb/api/docs/GitSource.md +++ b/koyeb/api/docs/GitSource.md @@ -16,6 +16,7 @@ Name | Type | Description | Notes **buildpack** | [**BuildpackBuilder**](BuildpackBuilder.md) | | [optional] **docker** | [**DockerBuilder**](DockerBuilder.md) | | [optional] **credential_source** | **str** | Credentials can come from a specific source or default to using Github (when unset or set to \"github\"). | [optional] +**skip_submodules** | **bool** | A flag to skip initializing git submodules when cloning the repository. | [optional] ## Example diff --git a/koyeb/api/docs/KmetaGetOrganizationWorkspaceQuotasReply.md b/koyeb/api/docs/KmetaGetOrganizationWorkspaceQuotasReply.md new file mode 100644 index 00000000..24d6e8bb --- /dev/null +++ b/koyeb/api/docs/KmetaGetOrganizationWorkspaceQuotasReply.md @@ -0,0 +1,29 @@ +# KmetaGetOrganizationWorkspaceQuotasReply + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**quotas** | [**Quotas**](Quotas.md) | | [optional] + +## Example + +```python +from koyeb.api.models.kmeta_get_organization_workspace_quotas_reply import KmetaGetOrganizationWorkspaceQuotasReply + +# TODO update the JSON string below +json = "{}" +# create an instance of KmetaGetOrganizationWorkspaceQuotasReply from a JSON string +kmeta_get_organization_workspace_quotas_reply_instance = KmetaGetOrganizationWorkspaceQuotasReply.from_json(json) +# print the JSON string representation of the object +print(KmetaGetOrganizationWorkspaceQuotasReply.to_json()) + +# convert the object into a dict +kmeta_get_organization_workspace_quotas_reply_dict = kmeta_get_organization_workspace_quotas_reply_instance.to_dict() +# create an instance of KmetaGetOrganizationWorkspaceQuotasReply from a dict +kmeta_get_organization_workspace_quotas_reply_from_dict = KmetaGetOrganizationWorkspaceQuotasReply.from_dict(kmeta_get_organization_workspace_quotas_reply_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/koyeb/api/docs/ListArchivesReply.md b/koyeb/api/docs/ListArchivesReply.md new file mode 100644 index 00000000..18b57c6f --- /dev/null +++ b/koyeb/api/docs/ListArchivesReply.md @@ -0,0 +1,33 @@ +# ListArchivesReply + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**archives** | [**List[Archive]**](Archive.md) | | [optional] +**limit** | **int** | | [optional] +**offset** | **int** | | [optional] +**count** | **int** | | [optional] +**has_next** | **bool** | | [optional] + +## Example + +```python +from koyeb.api.models.list_archives_reply import ListArchivesReply + +# TODO update the JSON string below +json = "{}" +# create an instance of ListArchivesReply from a JSON string +list_archives_reply_instance = ListArchivesReply.from_json(json) +# print the JSON string representation of the object +print(ListArchivesReply.to_json()) + +# convert the object into a dict +list_archives_reply_dict = list_archives_reply_instance.to_dict() +# create an instance of ListArchivesReply from a dict +list_archives_reply_from_dict = ListArchivesReply.from_dict(list_archives_reply_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/koyeb/api/docs/PoolClaim.md b/koyeb/api/docs/PoolClaim.md index 8329914c..1f351997 100644 --- a/koyeb/api/docs/PoolClaim.md +++ b/koyeb/api/docs/PoolClaim.md @@ -12,10 +12,8 @@ Name | Type | Description | Notes **status** | [**PoolClaimStatus**](PoolClaimStatus.md) | | [optional] [default to PoolClaimStatus.UNSPECIFIED] **organization_id** | **str** | | [optional] **workspace_id** | **str** | | [optional] -**customer_id** | **str** | | [optional] **created_at** | **datetime** | | [optional] **fulfilled_at** | **datetime** | | [optional] -**released_at** | **datetime** | | [optional] **pool_generation** | **str** | | [optional] ## Example diff --git a/koyeb/api/docs/PoolClaimRequest.md b/koyeb/api/docs/PoolClaimRequest.md index d793a208..ecfc3473 100644 --- a/koyeb/api/docs/PoolClaimRequest.md +++ b/koyeb/api/docs/PoolClaimRequest.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pool_id** | **str** | | [optional] -**request_id** | **str** | | [optional] +**request_id** | **str** | Idempotency key scoped to the pool: retries with the same value return the same claim. A fresh id is generated when omitted. | [optional] ## Example diff --git a/koyeb/api/docs/PoolClaimStatus.md b/koyeb/api/docs/PoolClaimStatus.md index 0fd605aa..cc826a4e 100644 --- a/koyeb/api/docs/PoolClaimStatus.md +++ b/koyeb/api/docs/PoolClaimStatus.md @@ -11,8 +11,6 @@ * `FAILED` (value: `'FAILED'`) -* `RELEASED` (value: `'RELEASED'`) - [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/koyeb/api/docs/QueryServicesViewFilters.md b/koyeb/api/docs/QueryServicesViewFilters.md new file mode 100644 index 00000000..bc7d96a1 --- /dev/null +++ b/koyeb/api/docs/QueryServicesViewFilters.md @@ -0,0 +1,35 @@ +# QueryServicesViewFilters + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**types** | [**List[ServiceType]**](ServiceType.md) | | [optional] +**statuses** | [**List[ServiceStatus]**](ServiceStatus.md) | | [optional] +**regions** | **List[str]** | | [optional] +**app_ids** | **List[str]** | | [optional] +**active_deployment_states** | [**List[ServiceViewActiveDeploymentState]**](ServiceViewActiveDeploymentState.md) | | [optional] +**latest_deployment_states** | [**List[ServiceViewLatestDeploymentState]**](ServiceViewLatestDeploymentState.md) | | [optional] +**needs_attention** | **bool** | | [optional] + +## Example + +```python +from koyeb.api.models.query_services_view_filters import QueryServicesViewFilters + +# TODO update the JSON string below +json = "{}" +# create an instance of QueryServicesViewFilters from a JSON string +query_services_view_filters_instance = QueryServicesViewFilters.from_json(json) +# print the JSON string representation of the object +print(QueryServicesViewFilters.to_json()) + +# convert the object into a dict +query_services_view_filters_dict = query_services_view_filters_instance.to_dict() +# create an instance of QueryServicesViewFilters from a dict +query_services_view_filters_from_dict = QueryServicesViewFilters.from_dict(query_services_view_filters_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/koyeb/api/docs/QueryServicesViewReply.md b/koyeb/api/docs/QueryServicesViewReply.md new file mode 100644 index 00000000..91e02824 --- /dev/null +++ b/koyeb/api/docs/QueryServicesViewReply.md @@ -0,0 +1,35 @@ +# QueryServicesViewReply + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**services** | [**List[ServiceViewRow]**](ServiceViewRow.md) | | [optional] +**groups** | [**List[ServiceViewGroup]**](ServiceViewGroup.md) | | [optional] +**facets** | [**List[ServiceViewFacet]**](ServiceViewFacet.md) | | [optional] +**limit** | **int** | | [optional] +**offset** | **int** | | [optional] +**count** | **int** | | [optional] +**has_next** | **bool** | | [optional] + +## Example + +```python +from koyeb.api.models.query_services_view_reply import QueryServicesViewReply + +# TODO update the JSON string below +json = "{}" +# create an instance of QueryServicesViewReply from a JSON string +query_services_view_reply_instance = QueryServicesViewReply.from_json(json) +# print the JSON string representation of the object +print(QueryServicesViewReply.to_json()) + +# convert the object into a dict +query_services_view_reply_dict = query_services_view_reply_instance.to_dict() +# create an instance of QueryServicesViewReply from a dict +query_services_view_reply_from_dict = QueryServicesViewReply.from_dict(query_services_view_reply_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/koyeb/api/docs/QueryServicesViewSort.md b/koyeb/api/docs/QueryServicesViewSort.md new file mode 100644 index 00000000..e567302d --- /dev/null +++ b/koyeb/api/docs/QueryServicesViewSort.md @@ -0,0 +1,30 @@ +# QueryServicesViewSort + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_field** | [**QueryServicesViewSortField**](QueryServicesViewSortField.md) | | [optional] [default to QueryServicesViewSortField.CREATED_AT] +**direction** | [**QueryServicesViewSortDirection**](QueryServicesViewSortDirection.md) | | [optional] [default to QueryServicesViewSortDirection.ASC] + +## Example + +```python +from koyeb.api.models.query_services_view_sort import QueryServicesViewSort + +# TODO update the JSON string below +json = "{}" +# create an instance of QueryServicesViewSort from a JSON string +query_services_view_sort_instance = QueryServicesViewSort.from_json(json) +# print the JSON string representation of the object +print(QueryServicesViewSort.to_json()) + +# convert the object into a dict +query_services_view_sort_dict = query_services_view_sort_instance.to_dict() +# create an instance of QueryServicesViewSort from a dict +query_services_view_sort_from_dict = QueryServicesViewSort.from_dict(query_services_view_sort_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/koyeb/api/docs/QueryServicesViewSortDirection.md b/koyeb/api/docs/QueryServicesViewSortDirection.md new file mode 100644 index 00000000..4907e5f1 --- /dev/null +++ b/koyeb/api/docs/QueryServicesViewSortDirection.md @@ -0,0 +1,12 @@ +# QueryServicesViewSortDirection + + +## Enum + +* `ASC` (value: `'ASC'`) + +* `DESC` (value: `'DESC'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/koyeb/api/docs/QueryServicesViewSortField.md b/koyeb/api/docs/QueryServicesViewSortField.md new file mode 100644 index 00000000..24fec507 --- /dev/null +++ b/koyeb/api/docs/QueryServicesViewSortField.md @@ -0,0 +1,20 @@ +# QueryServicesViewSortField + + +## Enum + +* `CREATED_AT` (value: `'CREATED_AT'`) + +* `UPDATED_AT` (value: `'UPDATED_AT'`) + +* `NAME` (value: `'NAME'`) + +* `APP_NAME` (value: `'APP_NAME'`) + +* `ACTIVE_DEPLOYMENT_STATE` (value: `'ACTIVE_DEPLOYMENT_STATE'`) + +* `LATEST_DEPLOYMENT_STATE` (value: `'LATEST_DEPLOYMENT_STATE'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/koyeb/api/docs/Quotas.md b/koyeb/api/docs/Quotas.md index be8a6bf5..0106e01c 100644 --- a/koyeb/api/docs/Quotas.md +++ b/koyeb/api/docs/Quotas.md @@ -27,6 +27,7 @@ Name | Type | Description | Notes **lifecycle** | [**LifecycleQuotas**](LifecycleQuotas.md) | | [optional] **max_projects** | **str** | | [optional] **instance_snapshots** | [**InstanceSnapshotQuotas**](InstanceSnapshotQuotas.md) | | [optional] +**persistent_volumes_disabled** | **bool** | When true, persistent volumes are disabled for the organization regardless of persistent_volumes_by_region. kaccount's ComputeQuotas omits persistent_volumes_by_region when this is set, so the flag must travel explicitly — otherwise consumers cannot distinguish \"disabled\" from \"no custom quotas\". | [optional] ## Example diff --git a/koyeb/api/docs/QuotasApi.md b/koyeb/api/docs/QuotasApi.md index 3ce6ad3c..25999bb2 100644 --- a/koyeb/api/docs/QuotasApi.md +++ b/koyeb/api/docs/QuotasApi.md @@ -5,6 +5,7 @@ All URIs are relative to *https://app.koyeb.com* Method | HTTP request | Description ------------- | ------------- | ------------- [**get_organization_quotas_usage**](QuotasApi.md#get_organization_quotas_usage) | **GET** /v1/quotas/organizations/{organization_id}/usage | Return the organization's current quota usage alongside the plan's limits. Response is cached in Redis for 60s. Accept text/plain (or ?format=prometheus) to receive the response rendered as Prometheus text exposition format (\"koyeb_quota_<x>\" for usage, \"koyeb_quota_<x>_limit\" for the plan limit) suitable for scraping into an external Prometheus. +[**get_organization_workspace_quotas**](QuotasApi.md#get_organization_workspace_quotas) | **GET** /v1/quotas/organizations/{organization_id}/{workspace_id}/quotas | [**review_organization_capacity**](QuotasApi.md#review_organization_capacity) | **POST** /v1/quotas/capacity | DEPRECATED: Review Organization Capacity @@ -92,6 +93,83 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **get_organization_workspace_quotas** +> KmetaGetOrganizationWorkspaceQuotasReply get_organization_workspace_quotas(organization_id, workspace_id) + +### Example + +* Api Key Authentication (Bearer): + +```python +import koyeb.api +from koyeb.api.models.kmeta_get_organization_workspace_quotas_reply import KmetaGetOrganizationWorkspaceQuotasReply +from koyeb.api.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://app.koyeb.com +# See configuration.py for a list of all supported configuration parameters. +configuration = koyeb.api.Configuration( + host = "https://app.koyeb.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: Bearer +configuration.api_key['Bearer'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Bearer'] = 'Bearer' + +# Enter a context with an instance of the API client +with koyeb.api.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = koyeb.api.QuotasApi(api_client) + organization_id = 'organization_id_example' # str | + workspace_id = 'workspace_id_example' # str | + + try: + api_response = api_instance.get_organization_workspace_quotas(organization_id, workspace_id) + print("The response of QuotasApi->get_organization_workspace_quotas:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling QuotasApi->get_organization_workspace_quotas: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_id** | **str**| | + **workspace_id** | **str**| | + +### Return type + +[**KmetaGetOrganizationWorkspaceQuotasReply**](KmetaGetOrganizationWorkspaceQuotasReply.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | A successful response. | - | +**0** | An unexpected error response. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **review_organization_capacity** > ReviewOrganizationCapacityReply review_organization_capacity(body) diff --git a/koyeb/api/docs/RegionalDeploymentDefinition.md b/koyeb/api/docs/RegionalDeploymentDefinition.md index e60e8779..d335fcfd 100644 --- a/koyeb/api/docs/RegionalDeploymentDefinition.md +++ b/koyeb/api/docs/RegionalDeploymentDefinition.md @@ -21,6 +21,7 @@ Name | Type | Description | Notes **skip_cache** | **bool** | | [optional] **mesh** | [**RegionalDeploymentMesh**](RegionalDeploymentMesh.md) | | [optional] [default to RegionalDeploymentMesh.REGIONAL_DEPLOYMENT_MESH_AUTO] **network_policy** | [**NetworkPolicy**](NetworkPolicy.md) | | [optional] +**kill_timeout_secs** | **int** | | [optional] **docker** | [**DockerSource**](DockerSource.md) | | [optional] **git** | [**GitSource**](GitSource.md) | | [optional] **archive** | [**ArchiveSource**](ArchiveSource.md) | | [optional] diff --git a/koyeb/api/docs/SandboxMetadata.md b/koyeb/api/docs/SandboxMetadata.md index 43fff91a..f394d766 100644 --- a/koyeb/api/docs/SandboxMetadata.md +++ b/koyeb/api/docs/SandboxMetadata.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **public_url** | **str** | | [optional] **routing_key** | **str** | | [optional] +**internal_url** | **str** | | [optional] ## Example diff --git a/koyeb/api/docs/ServicePool.md b/koyeb/api/docs/ServicePool.md index d86f30ce..1bf0eb02 100644 --- a/koyeb/api/docs/ServicePool.md +++ b/koyeb/api/docs/ServicePool.md @@ -17,7 +17,6 @@ Name | Type | Description | Notes **status** | [**ServicePoolStatus**](ServicePoolStatus.md) | | [optional] [default to ServicePoolStatus.UNSPECIFIED] **messages** | **List[str]** | | [optional] **generation** | **str** | | [optional] -**customer_id** | **str** | | [optional] ## Example diff --git a/koyeb/api/docs/ServiceViewActiveDeployment.md b/koyeb/api/docs/ServiceViewActiveDeployment.md new file mode 100644 index 00000000..4d311617 --- /dev/null +++ b/koyeb/api/docs/ServiceViewActiveDeployment.md @@ -0,0 +1,34 @@ +# ServiceViewActiveDeployment + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**state** | [**ServiceViewActiveDeploymentState**](ServiceViewActiveDeploymentState.md) | | [optional] [default to ServiceViewActiveDeploymentState.NONE] +**id** | **str** | | [optional] +**missing** | **bool** | | [optional] +**status** | [**DeploymentStatus**](DeploymentStatus.md) | | [optional] [default to DeploymentStatus.PENDING] +**created_at** | **datetime** | | [optional] +**updated_at** | **datetime** | | [optional] + +## Example + +```python +from koyeb.api.models.service_view_active_deployment import ServiceViewActiveDeployment + +# TODO update the JSON string below +json = "{}" +# create an instance of ServiceViewActiveDeployment from a JSON string +service_view_active_deployment_instance = ServiceViewActiveDeployment.from_json(json) +# print the JSON string representation of the object +print(ServiceViewActiveDeployment.to_json()) + +# convert the object into a dict +service_view_active_deployment_dict = service_view_active_deployment_instance.to_dict() +# create an instance of ServiceViewActiveDeployment from a dict +service_view_active_deployment_from_dict = ServiceViewActiveDeployment.from_dict(service_view_active_deployment_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/koyeb/api/docs/ServiceViewActiveDeploymentState.md b/koyeb/api/docs/ServiceViewActiveDeploymentState.md new file mode 100644 index 00000000..40b45f5c --- /dev/null +++ b/koyeb/api/docs/ServiceViewActiveDeploymentState.md @@ -0,0 +1,25 @@ +# ServiceViewActiveDeploymentState + +- SLEEPING: The active Deployment is scaled to zero and wakes up on traffic + +## Enum + +* `NONE` (value: `'NONE'`) + +* `STARTING` (value: `'STARTING'`) + +* `HEALTHY` (value: `'HEALTHY'`) + +* `DEGRADED` (value: `'DEGRADED'`) + +* `UNHEALTHY` (value: `'UNHEALTHY'`) + +* `STOPPING` (value: `'STOPPING'`) + +* `PAUSED` (value: `'PAUSED'`) + +* `SLEEPING` (value: `'SLEEPING'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/koyeb/api/docs/ServiceViewApp.md b/koyeb/api/docs/ServiceViewApp.md new file mode 100644 index 00000000..0d656da7 --- /dev/null +++ b/koyeb/api/docs/ServiceViewApp.md @@ -0,0 +1,30 @@ +# ServiceViewApp + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] +**name** | **str** | | [optional] + +## Example + +```python +from koyeb.api.models.service_view_app import ServiceViewApp + +# TODO update the JSON string below +json = "{}" +# create an instance of ServiceViewApp from a JSON string +service_view_app_instance = ServiceViewApp.from_json(json) +# print the JSON string representation of the object +print(ServiceViewApp.to_json()) + +# convert the object into a dict +service_view_app_dict = service_view_app_instance.to_dict() +# create an instance of ServiceViewApp from a dict +service_view_app_from_dict = ServiceViewApp.from_dict(service_view_app_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/koyeb/api/docs/ServiceViewFacet.md b/koyeb/api/docs/ServiceViewFacet.md new file mode 100644 index 00000000..d232fb50 --- /dev/null +++ b/koyeb/api/docs/ServiceViewFacet.md @@ -0,0 +1,30 @@ +# ServiceViewFacet + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**kind** | [**ServiceViewFacetKind**](ServiceViewFacetKind.md) | | [optional] [default to ServiceViewFacetKind.TYPE] +**values** | [**List[ServiceViewFacetValue]**](ServiceViewFacetValue.md) | | [optional] + +## Example + +```python +from koyeb.api.models.service_view_facet import ServiceViewFacet + +# TODO update the JSON string below +json = "{}" +# create an instance of ServiceViewFacet from a JSON string +service_view_facet_instance = ServiceViewFacet.from_json(json) +# print the JSON string representation of the object +print(ServiceViewFacet.to_json()) + +# convert the object into a dict +service_view_facet_dict = service_view_facet_instance.to_dict() +# create an instance of ServiceViewFacet from a dict +service_view_facet_from_dict = ServiceViewFacet.from_dict(service_view_facet_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/koyeb/api/docs/ServiceViewFacetKind.md b/koyeb/api/docs/ServiceViewFacetKind.md new file mode 100644 index 00000000..741fd93f --- /dev/null +++ b/koyeb/api/docs/ServiceViewFacetKind.md @@ -0,0 +1,22 @@ +# ServiceViewFacetKind + + +## Enum + +* `TYPE` (value: `'TYPE'`) + +* `STATUS` (value: `'STATUS'`) + +* `REGION` (value: `'REGION'`) + +* `APP` (value: `'APP'`) + +* `ACTIVE_DEPLOYMENT_STATE` (value: `'ACTIVE_DEPLOYMENT_STATE'`) + +* `LATEST_DEPLOYMENT_STATE` (value: `'LATEST_DEPLOYMENT_STATE'`) + +* `NEEDS_ATTENTION` (value: `'NEEDS_ATTENTION'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/koyeb/api/docs/ServiceViewFacetValue.md b/koyeb/api/docs/ServiceViewFacetValue.md new file mode 100644 index 00000000..1a397f3f --- /dev/null +++ b/koyeb/api/docs/ServiceViewFacetValue.md @@ -0,0 +1,31 @@ +# ServiceViewFacetValue + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | | [optional] +**label** | **str** | | [optional] +**count** | **int** | | [optional] + +## Example + +```python +from koyeb.api.models.service_view_facet_value import ServiceViewFacetValue + +# TODO update the JSON string below +json = "{}" +# create an instance of ServiceViewFacetValue from a JSON string +service_view_facet_value_instance = ServiceViewFacetValue.from_json(json) +# print the JSON string representation of the object +print(ServiceViewFacetValue.to_json()) + +# convert the object into a dict +service_view_facet_value_dict = service_view_facet_value_instance.to_dict() +# create an instance of ServiceViewFacetValue from a dict +service_view_facet_value_from_dict = ServiceViewFacetValue.from_dict(service_view_facet_value_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/koyeb/api/docs/ServiceViewGroup.md b/koyeb/api/docs/ServiceViewGroup.md new file mode 100644 index 00000000..88c40b9c --- /dev/null +++ b/koyeb/api/docs/ServiceViewGroup.md @@ -0,0 +1,32 @@ +# ServiceViewGroup + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**by** | [**ServiceViewGroupBy**](ServiceViewGroupBy.md) | | [optional] [default to ServiceViewGroupBy.NO_GROUP] +**key** | **str** | | [optional] +**label** | **str** | | [optional] +**count** | **int** | | [optional] + +## Example + +```python +from koyeb.api.models.service_view_group import ServiceViewGroup + +# TODO update the JSON string below +json = "{}" +# create an instance of ServiceViewGroup from a JSON string +service_view_group_instance = ServiceViewGroup.from_json(json) +# print the JSON string representation of the object +print(ServiceViewGroup.to_json()) + +# convert the object into a dict +service_view_group_dict = service_view_group_instance.to_dict() +# create an instance of ServiceViewGroup from a dict +service_view_group_from_dict = ServiceViewGroup.from_dict(service_view_group_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/koyeb/api/docs/ServiceViewGroupBy.md b/koyeb/api/docs/ServiceViewGroupBy.md new file mode 100644 index 00000000..1b49b162 --- /dev/null +++ b/koyeb/api/docs/ServiceViewGroupBy.md @@ -0,0 +1,12 @@ +# ServiceViewGroupBy + + +## Enum + +* `NO_GROUP` (value: `'NO_GROUP'`) + +* `APP` (value: `'APP'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/koyeb/api/docs/ServiceViewLatestDeployment.md b/koyeb/api/docs/ServiceViewLatestDeployment.md new file mode 100644 index 00000000..8c066453 --- /dev/null +++ b/koyeb/api/docs/ServiceViewLatestDeployment.md @@ -0,0 +1,34 @@ +# ServiceViewLatestDeployment + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**state** | [**ServiceViewLatestDeploymentState**](ServiceViewLatestDeploymentState.md) | | [optional] [default to ServiceViewLatestDeploymentState.NONE] +**id** | **str** | | [optional] +**missing** | **bool** | | [optional] +**status** | [**DeploymentStatus**](DeploymentStatus.md) | | [optional] [default to DeploymentStatus.PENDING] +**created_at** | **datetime** | | [optional] +**updated_at** | **datetime** | | [optional] + +## Example + +```python +from koyeb.api.models.service_view_latest_deployment import ServiceViewLatestDeployment + +# TODO update the JSON string below +json = "{}" +# create an instance of ServiceViewLatestDeployment from a JSON string +service_view_latest_deployment_instance = ServiceViewLatestDeployment.from_json(json) +# print the JSON string representation of the object +print(ServiceViewLatestDeployment.to_json()) + +# convert the object into a dict +service_view_latest_deployment_dict = service_view_latest_deployment_instance.to_dict() +# create an instance of ServiceViewLatestDeployment from a dict +service_view_latest_deployment_from_dict = ServiceViewLatestDeployment.from_dict(service_view_latest_deployment_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/koyeb/api/docs/ServiceViewLatestDeploymentState.md b/koyeb/api/docs/ServiceViewLatestDeploymentState.md new file mode 100644 index 00000000..4351c0e5 --- /dev/null +++ b/koyeb/api/docs/ServiceViewLatestDeploymentState.md @@ -0,0 +1,16 @@ +# ServiceViewLatestDeploymentState + + +## Enum + +* `NONE` (value: `'NONE'`) + +* `STARTING` (value: `'STARTING'`) + +* `STOPPING` (value: `'STOPPING'`) + +* `FAILED` (value: `'FAILED'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/koyeb/api/docs/ServiceViewRow.md b/koyeb/api/docs/ServiceViewRow.md new file mode 100644 index 00000000..d2f42555 --- /dev/null +++ b/koyeb/api/docs/ServiceViewRow.md @@ -0,0 +1,43 @@ +# ServiceViewRow + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] +**name** | **str** | | [optional] +**type** | [**ServiceType**](ServiceType.md) | | [optional] [default to ServiceType.INVALID_TYPE] +**status** | [**ServiceStatus**](ServiceStatus.md) | | [optional] [default to ServiceStatus.STARTING] +**messages** | **List[str]** | | [optional] +**created_at** | **datetime** | | [optional] +**updated_at** | **datetime** | | [optional] +**app_id** | **str** | | [optional] +**app** | [**ServiceViewApp**](ServiceViewApp.md) | | [optional] +**active_deployment** | [**ServiceViewActiveDeployment**](ServiceViewActiveDeployment.md) | | [optional] +**latest_deployment** | [**ServiceViewLatestDeployment**](ServiceViewLatestDeployment.md) | | [optional] +**needs_attention** | **bool** | | [optional] +**regions** | **List[str]** | | [optional] +**instance_type** | **str** | | [optional] +**source** | [**ServiceViewSource**](ServiceViewSource.md) | | [optional] + +## Example + +```python +from koyeb.api.models.service_view_row import ServiceViewRow + +# TODO update the JSON string below +json = "{}" +# create an instance of ServiceViewRow from a JSON string +service_view_row_instance = ServiceViewRow.from_json(json) +# print the JSON string representation of the object +print(ServiceViewRow.to_json()) + +# convert the object into a dict +service_view_row_dict = service_view_row_instance.to_dict() +# create an instance of ServiceViewRow from a dict +service_view_row_from_dict = ServiceViewRow.from_dict(service_view_row_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/koyeb/api/docs/ServiceViewSource.md b/koyeb/api/docs/ServiceViewSource.md new file mode 100644 index 00000000..e2cb53e5 --- /dev/null +++ b/koyeb/api/docs/ServiceViewSource.md @@ -0,0 +1,30 @@ +# ServiceViewSource + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**ServiceViewSourceType**](ServiceViewSourceType.md) | | [optional] [default to ServiceViewSourceType.UNKNOWN] +**reference** | **str** | | [optional] + +## Example + +```python +from koyeb.api.models.service_view_source import ServiceViewSource + +# TODO update the JSON string below +json = "{}" +# create an instance of ServiceViewSource from a JSON string +service_view_source_instance = ServiceViewSource.from_json(json) +# print the JSON string representation of the object +print(ServiceViewSource.to_json()) + +# convert the object into a dict +service_view_source_dict = service_view_source_instance.to_dict() +# create an instance of ServiceViewSource from a dict +service_view_source_from_dict = ServiceViewSource.from_dict(service_view_source_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/koyeb/api/docs/ServiceViewSourceType.md b/koyeb/api/docs/ServiceViewSourceType.md new file mode 100644 index 00000000..ab2b7da7 --- /dev/null +++ b/koyeb/api/docs/ServiceViewSourceType.md @@ -0,0 +1,18 @@ +# ServiceViewSourceType + + +## Enum + +* `UNKNOWN` (value: `'UNKNOWN'`) + +* `DOCKER` (value: `'DOCKER'`) + +* `GIT` (value: `'GIT'`) + +* `ARCHIVE` (value: `'ARCHIVE'`) + +* `DATABASE` (value: `'DATABASE'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/koyeb/api/docs/ServiceViewsApi.md b/koyeb/api/docs/ServiceViewsApi.md new file mode 100644 index 00000000..48c38d68 --- /dev/null +++ b/koyeb/api/docs/ServiceViewsApi.md @@ -0,0 +1,125 @@ +# koyeb.api.ServiceViewsApi + +All URIs are relative to *https://app.koyeb.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**query_services_view**](ServiceViewsApi.md#query_services_view) | **GET** /v1/views/services | Query the Services view + + +# **query_services_view** +> QueryServicesViewReply query_services_view(search=search, filters_types=filters_types, filters_statuses=filters_statuses, filters_regions=filters_regions, filters_app_ids=filters_app_ids, filters_active_deployment_states=filters_active_deployment_states, filters_latest_deployment_states=filters_latest_deployment_states, filters_needs_attention=filters_needs_attention, sort_field=sort_field, sort_direction=sort_direction, group_by=group_by, limit=limit, offset=offset, facets=facets) + +Query the Services view + +Unstable: this endpoint may change without notice. + +Returns Services with their App and Deployment state. Filters, search, +sorting, grouping, counts and facets are all computed on the full +authorized result before pagination. + +### Example + +* Api Key Authentication (Bearer): + +```python +import koyeb.api +from koyeb.api.models.query_services_view_reply import QueryServicesViewReply +from koyeb.api.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://app.koyeb.com +# See configuration.py for a list of all supported configuration parameters. +configuration = koyeb.api.Configuration( + host = "https://app.koyeb.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: Bearer +configuration.api_key['Bearer'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Bearer'] = 'Bearer' + +# Enter a context with an instance of the API client +with koyeb.api.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = koyeb.api.ServiceViewsApi(api_client) + search = 'search_example' # str | (Optional) Case-insensitive search on the Service name and the App name (optional) + filters_types = ['filters_types_example'] # List[str] | (Optional) Filter on Service types (optional) + filters_statuses = ['filters_statuses_example'] # List[str] | (Optional) Filter on Service statuses (optional) + filters_regions = ['filters_regions_example'] # List[str] | (Optional) Filter on regions of the latest Deployment (optional) + filters_app_ids = ['filters_app_ids_example'] # List[str] | (Optional) Filter on App ids (optional) + filters_active_deployment_states = ['filters_active_deployment_states_example'] # List[str] | (Optional) Filter on active Deployment states - SLEEPING: The active Deployment is scaled to zero and wakes up on traffic (optional) + filters_latest_deployment_states = ['filters_latest_deployment_states_example'] # List[str] | (Optional) Filter on latest Deployment states (optional) + filters_needs_attention = True # bool | (Optional) Filter on Services that need attention (optional) + sort_field = 'CREATED_AT' # str | (optional) (default to 'CREATED_AT') + sort_direction = 'ASC' # str | (optional) (default to 'ASC') + group_by = 'NO_GROUP' # str | (Optional) Group rows by App. Groups are ordered by App name and keep a stable order across pages. Pagination always counts Services (optional) (default to 'NO_GROUP') + limit = 'limit_example' # str | (Optional) The number of items to return (optional) + offset = 'offset_example' # str | (Optional) The offset in the list of item to return (optional) + facets = ['facets_example'] # List[str] | (Optional) Facets to compute on the full result (optional) + + try: + # Query the Services view + api_response = api_instance.query_services_view(search=search, filters_types=filters_types, filters_statuses=filters_statuses, filters_regions=filters_regions, filters_app_ids=filters_app_ids, filters_active_deployment_states=filters_active_deployment_states, filters_latest_deployment_states=filters_latest_deployment_states, filters_needs_attention=filters_needs_attention, sort_field=sort_field, sort_direction=sort_direction, group_by=group_by, limit=limit, offset=offset, facets=facets) + print("The response of ServiceViewsApi->query_services_view:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceViewsApi->query_services_view: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **search** | **str**| (Optional) Case-insensitive search on the Service name and the App name | [optional] + **filters_types** | [**List[str]**](str.md)| (Optional) Filter on Service types | [optional] + **filters_statuses** | [**List[str]**](str.md)| (Optional) Filter on Service statuses | [optional] + **filters_regions** | [**List[str]**](str.md)| (Optional) Filter on regions of the latest Deployment | [optional] + **filters_app_ids** | [**List[str]**](str.md)| (Optional) Filter on App ids | [optional] + **filters_active_deployment_states** | [**List[str]**](str.md)| (Optional) Filter on active Deployment states - SLEEPING: The active Deployment is scaled to zero and wakes up on traffic | [optional] + **filters_latest_deployment_states** | [**List[str]**](str.md)| (Optional) Filter on latest Deployment states | [optional] + **filters_needs_attention** | **bool**| (Optional) Filter on Services that need attention | [optional] + **sort_field** | **str**| | [optional] [default to 'CREATED_AT'] + **sort_direction** | **str**| | [optional] [default to 'ASC'] + **group_by** | **str**| (Optional) Group rows by App. Groups are ordered by App name and keep a stable order across pages. Pagination always counts Services | [optional] [default to 'NO_GROUP'] + **limit** | **str**| (Optional) The number of items to return | [optional] + **offset** | **str**| (Optional) The offset in the list of item to return | [optional] + **facets** | [**List[str]**](str.md)| (Optional) Facets to compute on the full result | [optional] + +### Return type + +[**QueryServicesViewReply**](QueryServicesViewReply.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | A successful response. | - | +**400** | Validation error | - | +**401** | Returned when the token is not valid. | - | +**403** | Returned when the user does not have permission to access the resource. | - | +**404** | Returned when the resource does not exist. | - | +**500** | Returned in case of server error. | - | +**503** | Service is unavailable. | - | +**0** | An unexpected error response. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/koyeb/api/docs/SnapshotStatus.md b/koyeb/api/docs/SnapshotStatus.md index bbc2964f..7a0e82c0 100644 --- a/koyeb/api/docs/SnapshotStatus.md +++ b/koyeb/api/docs/SnapshotStatus.md @@ -15,6 +15,8 @@ * `SNAPSHOT_STATUS_DELETED` (value: `'SNAPSHOT_STATUS_DELETED'`) +* `SNAPSHOT_STATUS_ERROR` (value: `'SNAPSHOT_STATUS_ERROR'`) + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/koyeb/api/docs/SnapshotsApi.md b/koyeb/api/docs/SnapshotsApi.md index 89d433a3..7cf0ac87 100644 --- a/koyeb/api/docs/SnapshotsApi.md +++ b/koyeb/api/docs/SnapshotsApi.md @@ -303,7 +303,7 @@ with koyeb.api.ApiClient(configuration) as api_client: limit = 'limit_example' # str | (Optional) The number of items to return (optional) offset = 'offset_example' # str | (Optional) The offset in the list of item to return (optional) organization_id = 'organization_id_example' # str | (Optional) Filter by organization_id (optional) - statuses = ['statuses_example'] # List[str] | (Optional) Filter by status - SNAPSHOT_STATUS_INVALID: zero value, invalid - SNAPSHOT_STATUS_CREATING: the snapshot is being created - SNAPSHOT_STATUS_AVAILABLE: the snapshot is complete and available - SNAPSHOT_STATUS_MIGRATING: the snapshot is being migrated - SNAPSHOT_STATUS_DELETING: the snapshot is being deleted - SNAPSHOT_STATUS_DELETED: the snapshot is deleted (optional) + statuses = ['statuses_example'] # List[str] | (Optional) Filter by status - SNAPSHOT_STATUS_INVALID: zero value, invalid - SNAPSHOT_STATUS_CREATING: the snapshot is being created - SNAPSHOT_STATUS_AVAILABLE: the snapshot is complete and available - SNAPSHOT_STATUS_MIGRATING: the snapshot is being migrated - SNAPSHOT_STATUS_DELETING: the snapshot is being deleted - SNAPSHOT_STATUS_DELETED: the snapshot is deleted - SNAPSHOT_STATUS_ERROR: the snapshot could not be created (optional) region = 'region_example' # str | (Optional) A filter for the region (optional) ids = ['ids_example'] # List[str] | (Optional) Filter on snapshot ids (optional) @@ -326,7 +326,7 @@ Name | Type | Description | Notes **limit** | **str**| (Optional) The number of items to return | [optional] **offset** | **str**| (Optional) The offset in the list of item to return | [optional] **organization_id** | **str**| (Optional) Filter by organization_id | [optional] - **statuses** | [**List[str]**](str.md)| (Optional) Filter by status - SNAPSHOT_STATUS_INVALID: zero value, invalid - SNAPSHOT_STATUS_CREATING: the snapshot is being created - SNAPSHOT_STATUS_AVAILABLE: the snapshot is complete and available - SNAPSHOT_STATUS_MIGRATING: the snapshot is being migrated - SNAPSHOT_STATUS_DELETING: the snapshot is being deleted - SNAPSHOT_STATUS_DELETED: the snapshot is deleted | [optional] + **statuses** | [**List[str]**](str.md)| (Optional) Filter by status - SNAPSHOT_STATUS_INVALID: zero value, invalid - SNAPSHOT_STATUS_CREATING: the snapshot is being created - SNAPSHOT_STATUS_AVAILABLE: the snapshot is complete and available - SNAPSHOT_STATUS_MIGRATING: the snapshot is being migrated - SNAPSHOT_STATUS_DELETING: the snapshot is being deleted - SNAPSHOT_STATUS_DELETED: the snapshot is deleted - SNAPSHOT_STATUS_ERROR: the snapshot could not be created | [optional] **region** | **str**| (Optional) A filter for the region | [optional] **ids** | [**List[str]**](str.md)| (Optional) Filter on snapshot ids | [optional] diff --git a/koyeb/api/exceptions.py b/koyeb/api/exceptions.py index 5e517cf3..dc7f14a4 100644 --- a/koyeb/api/exceptions.py +++ b/koyeb/api/exceptions.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/__init__.py b/koyeb/api/models/__init__.py index 95d692f7..8f136e4c 100644 --- a/koyeb/api/models/__init__.py +++ b/koyeb/api/models/__init__.py @@ -4,7 +4,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -29,6 +29,7 @@ from koyeb.api.models.archive import Archive from koyeb.api.models.archive_deployment_metadata import ArchiveDeploymentMetadata from koyeb.api.models.archive_source import ArchiveSource +from koyeb.api.models.archive_status import ArchiveStatus from koyeb.api.models.auto_release import AutoRelease from koyeb.api.models.auto_release_group import AutoReleaseGroup from koyeb.api.models.autocomplete_reply import AutocompleteReply @@ -215,6 +216,7 @@ ) from koyeb.api.models.grpc_health_check import GRPCHealthCheck from koyeb.api.models.get_app_reply import GetAppReply +from koyeb.api.models.get_archive_reply import GetArchiveReply from koyeb.api.models.get_budget_reply import GetBudgetReply from koyeb.api.models.get_catalog_instance_reply import GetCatalogInstanceReply from koyeb.api.models.get_credential_reply import GetCredentialReply @@ -301,6 +303,9 @@ ) from koyeb.api.models.kgitproxy_repository import KgitproxyRepository from koyeb.api.models.kgitproxy_repository_provider import KgitproxyRepositoryProvider +from koyeb.api.models.kmeta_get_organization_workspace_quotas_reply import ( + KmetaGetOrganizationWorkspaceQuotasReply, +) from koyeb.api.models.ksearch_app import KsearchApp from koyeb.api.models.ksearch_global_deployment import KsearchGlobalDeployment from koyeb.api.models.ksearch_instance import KsearchInstance @@ -314,6 +319,7 @@ from koyeb.api.models.lifecycle_quotas import LifecycleQuotas from koyeb.api.models.list_app_events_reply import ListAppEventsReply from koyeb.api.models.list_apps_reply import ListAppsReply +from koyeb.api.models.list_archives_reply import ListArchivesReply from koyeb.api.models.list_catalog_instances_reply import ListCatalogInstancesReply from koyeb.api.models.list_credentials_reply import ListCredentialsReply from koyeb.api.models.list_datacenters_reply import ListDatacentersReply @@ -429,6 +435,13 @@ from koyeb.api.models.public_user import PublicUser from koyeb.api.models.query_logs_reply import QueryLogsReply from koyeb.api.models.query_logs_reply_pagination import QueryLogsReplyPagination +from koyeb.api.models.query_services_view_filters import QueryServicesViewFilters +from koyeb.api.models.query_services_view_reply import QueryServicesViewReply +from koyeb.api.models.query_services_view_sort import QueryServicesViewSort +from koyeb.api.models.query_services_view_sort_direction import ( + QueryServicesViewSortDirection, +) +from koyeb.api.models.query_services_view_sort_field import QueryServicesViewSortField from koyeb.api.models.quota_usage import QuotaUsage from koyeb.api.models.quotas import Quotas from koyeb.api.models.reactivate_organization_reply import ReactivateOrganizationReply @@ -485,6 +498,23 @@ from koyeb.api.models.service_summary import ServiceSummary from koyeb.api.models.service_type import ServiceType from koyeb.api.models.service_usage import ServiceUsage +from koyeb.api.models.service_view_active_deployment import ServiceViewActiveDeployment +from koyeb.api.models.service_view_active_deployment_state import ( + ServiceViewActiveDeploymentState, +) +from koyeb.api.models.service_view_app import ServiceViewApp +from koyeb.api.models.service_view_facet import ServiceViewFacet +from koyeb.api.models.service_view_facet_kind import ServiceViewFacetKind +from koyeb.api.models.service_view_facet_value import ServiceViewFacetValue +from koyeb.api.models.service_view_group import ServiceViewGroup +from koyeb.api.models.service_view_group_by import ServiceViewGroupBy +from koyeb.api.models.service_view_latest_deployment import ServiceViewLatestDeployment +from koyeb.api.models.service_view_latest_deployment_state import ( + ServiceViewLatestDeploymentState, +) +from koyeb.api.models.service_view_row import ServiceViewRow +from koyeb.api.models.service_view_source import ServiceViewSource +from koyeb.api.models.service_view_source_type import ServiceViewSourceType from koyeb.api.models.snapshot import Snapshot from koyeb.api.models.snapshot_status import SnapshotStatus from koyeb.api.models.snapshot_type import SnapshotType diff --git a/koyeb/api/models/accept_organization_invitation_reply.py b/koyeb/api/models/accept_organization_invitation_reply.py index 753f68b4..13e11eae 100644 --- a/koyeb/api/models/accept_organization_invitation_reply.py +++ b/koyeb/api/models/accept_organization_invitation_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/action.py b/koyeb/api/models/action.py index 56c31901..a0dd7136 100644 --- a/koyeb/api/models/action.py +++ b/koyeb/api/models/action.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/activity.py b/koyeb/api/models/activity.py index 498526b6..e03307f7 100644 --- a/koyeb/api/models/activity.py +++ b/koyeb/api/models/activity.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/activity_list.py b/koyeb/api/models/activity_list.py index e2c14126..27624e9c 100644 --- a/koyeb/api/models/activity_list.py +++ b/koyeb/api/models/activity_list.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/app.py b/koyeb/api/models/app.py index 27784a79..4f094d34 100644 --- a/koyeb/api/models/app.py +++ b/koyeb/api/models/app.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/app_event.py b/koyeb/api/models/app_event.py index 23a6b3cc..fa1cb8a2 100644 --- a/koyeb/api/models/app_event.py +++ b/koyeb/api/models/app_event.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/app_life_cycle.py b/koyeb/api/models/app_life_cycle.py index b6610fa4..9bc68b99 100644 --- a/koyeb/api/models/app_life_cycle.py +++ b/koyeb/api/models/app_life_cycle.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -17,7 +17,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, StrictBool +from pydantic import BaseModel, ConfigDict, Field, StrictBool from typing import Any, ClassVar, Dict, List, Optional from typing import Optional, Set from typing_extensions import Self @@ -29,7 +29,10 @@ class AppLifeCycle(BaseModel): AppLifeCycle """ # noqa: E501 - delete_when_empty: Optional[StrictBool] = None + delete_when_empty: Optional[StrictBool] = Field( + default=None, + description="If true, the app is deleted once it has no service left: either when its last service is deleted or, for an app that never had a service, once it is older than 15 minutes.", + ) __properties: ClassVar[List[str]] = ["delete_when_empty"] model_config = ConfigDict( diff --git a/koyeb/api/models/app_list_item.py b/koyeb/api/models/app_list_item.py index 5299d0c0..dad55ef9 100644 --- a/koyeb/api/models/app_list_item.py +++ b/koyeb/api/models/app_list_item.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/app_status.py b/koyeb/api/models/app_status.py index 73660fd3..bd3fafc1 100644 --- a/koyeb/api/models/app_status.py +++ b/koyeb/api/models/app_status.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/app_usage.py b/koyeb/api/models/app_usage.py index 0df87e48..b983acd3 100644 --- a/koyeb/api/models/app_usage.py +++ b/koyeb/api/models/app_usage.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/apps_summary.py b/koyeb/api/models/apps_summary.py index 86f1abe0..0a29ba63 100644 --- a/koyeb/api/models/apps_summary.py +++ b/koyeb/api/models/apps_summary.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/archive.py b/koyeb/api/models/archive.py index 098f9484..aee9e806 100644 --- a/koyeb/api/models/archive.py +++ b/koyeb/api/models/archive.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -20,6 +20,7 @@ from datetime import datetime from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List, Optional +from koyeb.api.models.archive_status import ArchiveStatus from typing import Optional, Set from typing_extensions import Self from pydantic_core import to_jsonable_python @@ -51,6 +52,14 @@ class Archive(BaseModel): default=None, description="This field is automatically set by Koyeb when the archive is garbage collected.", ) + download_url: Optional[StrictStr] = Field( + default=None, + description="A signed URL to download the archive. Getting an archive signs a new one when it has less than 5 minutes left, valid for 24 hours.", + ) + download_url_deadline: Optional[datetime] = Field( + default=None, description="When download_url expires." + ) + status: Optional[ArchiveStatus] = ArchiveStatus.ARCHIVE_STATUS_INVALID __properties: ClassVar[List[str]] = [ "id", "organization_id", @@ -58,6 +67,9 @@ class Archive(BaseModel): "size", "created_at", "deleted_at", + "download_url", + "download_url_deadline", + "status", ] model_config = ConfigDict( @@ -116,6 +128,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "size": obj.get("size"), "created_at": obj.get("created_at"), "deleted_at": obj.get("deleted_at"), + "download_url": obj.get("download_url"), + "download_url_deadline": obj.get("download_url_deadline"), + "status": obj.get("status") + if obj.get("status") is not None + else ArchiveStatus.ARCHIVE_STATUS_INVALID, } ) return _obj diff --git a/koyeb/api/models/archive_deployment_metadata.py b/koyeb/api/models/archive_deployment_metadata.py index 2ea27ec8..d08809fe 100644 --- a/koyeb/api/models/archive_deployment_metadata.py +++ b/koyeb/api/models/archive_deployment_metadata.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/archive_source.py b/koyeb/api/models/archive_source.py index 82ac1acb..55d9bd2e 100644 --- a/koyeb/api/models/archive_source.py +++ b/koyeb/api/models/archive_source.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/archive_status.py b/koyeb/api/models/archive_status.py new file mode 100644 index 00000000..f163f86a --- /dev/null +++ b/koyeb/api/models/archive_status.py @@ -0,0 +1,37 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class ArchiveStatus(str, Enum): + """ + ArchiveStatus + """ + + """ + allowed enum values + """ + ARCHIVE_STATUS_INVALID = "ARCHIVE_STATUS_INVALID" + ARCHIVE_STATUS_HEALTHY = "ARCHIVE_STATUS_HEALTHY" + ARCHIVE_STATUS_DELETING = "ARCHIVE_STATUS_DELETING" + ARCHIVE_STATUS_DELETED = "ARCHIVE_STATUS_DELETED" + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of ArchiveStatus from a JSON string""" + return cls(json.loads(json_str)) diff --git a/koyeb/api/models/auto_release.py b/koyeb/api/models/auto_release.py index 8ca1705e..ed5b2150 100644 --- a/koyeb/api/models/auto_release.py +++ b/koyeb/api/models/auto_release.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/auto_release_group.py b/koyeb/api/models/auto_release_group.py index 72aa4e3a..e16bc1e0 100644 --- a/koyeb/api/models/auto_release_group.py +++ b/koyeb/api/models/auto_release_group.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/autocomplete_reply.py b/koyeb/api/models/autocomplete_reply.py index d34a31c5..0825c11a 100644 --- a/koyeb/api/models/autocomplete_reply.py +++ b/koyeb/api/models/autocomplete_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/autocomplete_request.py b/koyeb/api/models/autocomplete_request.py index 309b7775..659ba30e 100644 --- a/koyeb/api/models/autocomplete_request.py +++ b/koyeb/api/models/autocomplete_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/availability_level.py b/koyeb/api/models/availability_level.py index dcda535b..1fcd44a4 100644 --- a/koyeb/api/models/availability_level.py +++ b/koyeb/api/models/availability_level.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/azure_container_registry_configuration.py b/koyeb/api/models/azure_container_registry_configuration.py index 4c23b323..2d417816 100644 --- a/koyeb/api/models/azure_container_registry_configuration.py +++ b/koyeb/api/models/azure_container_registry_configuration.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/basic_auth_policy.py b/koyeb/api/models/basic_auth_policy.py index 85eddef8..2e20901f 100644 --- a/koyeb/api/models/basic_auth_policy.py +++ b/koyeb/api/models/basic_auth_policy.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/budget.py b/koyeb/api/models/budget.py index d811b63a..46c21343 100644 --- a/koyeb/api/models/budget.py +++ b/koyeb/api/models/budget.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/buildpack_builder.py b/koyeb/api/models/buildpack_builder.py index 31d6f93f..edb5abdb 100644 --- a/koyeb/api/models/buildpack_builder.py +++ b/koyeb/api/models/buildpack_builder.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/canny_auth_reply.py b/koyeb/api/models/canny_auth_reply.py index 5475250c..2f98f5f5 100644 --- a/koyeb/api/models/canny_auth_reply.py +++ b/koyeb/api/models/canny_auth_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/catalog_gpu_details.py b/koyeb/api/models/catalog_gpu_details.py index 5a7321ae..1a1a2d28 100644 --- a/koyeb/api/models/catalog_gpu_details.py +++ b/koyeb/api/models/catalog_gpu_details.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/catalog_instance.py b/koyeb/api/models/catalog_instance.py index b9da6bca..4ebb4e64 100644 --- a/koyeb/api/models/catalog_instance.py +++ b/koyeb/api/models/catalog_instance.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/catalog_instance_list_item.py b/koyeb/api/models/catalog_instance_list_item.py index e40dec16..e79812b2 100644 --- a/koyeb/api/models/catalog_instance_list_item.py +++ b/koyeb/api/models/catalog_instance_list_item.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/catalog_usage.py b/koyeb/api/models/catalog_usage.py index 2eafbbae..d98f95d5 100644 --- a/koyeb/api/models/catalog_usage.py +++ b/koyeb/api/models/catalog_usage.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/check_coupon_reply.py b/koyeb/api/models/check_coupon_reply.py index 57e0905c..74f630e5 100644 --- a/koyeb/api/models/check_coupon_reply.py +++ b/koyeb/api/models/check_coupon_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/clear_idenfy_verification_result_request.py b/koyeb/api/models/clear_idenfy_verification_result_request.py index ad64d103..5bd098f9 100644 --- a/koyeb/api/models/clear_idenfy_verification_result_request.py +++ b/koyeb/api/models/clear_idenfy_verification_result_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/compose_reply.py b/koyeb/api/models/compose_reply.py index 2a51daf3..aa2e4c4b 100644 --- a/koyeb/api/models/compose_reply.py +++ b/koyeb/api/models/compose_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/config_file.py b/koyeb/api/models/config_file.py index 01300f05..7aab95ce 100644 --- a/koyeb/api/models/config_file.py +++ b/koyeb/api/models/config_file.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/confirm_payment_authorization_reply.py b/koyeb/api/models/confirm_payment_authorization_reply.py index da711360..a9403e37 100644 --- a/koyeb/api/models/confirm_payment_authorization_reply.py +++ b/koyeb/api/models/confirm_payment_authorization_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/create_access_token_reply.py b/koyeb/api/models/create_access_token_reply.py index 4e8d896b..99852106 100644 --- a/koyeb/api/models/create_access_token_reply.py +++ b/koyeb/api/models/create_access_token_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/create_access_token_request.py b/koyeb/api/models/create_access_token_request.py index fc62077c..1e1f2e4f 100644 --- a/koyeb/api/models/create_access_token_request.py +++ b/koyeb/api/models/create_access_token_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/create_account_request.py b/koyeb/api/models/create_account_request.py index a3ebcf36..7d22ca5c 100644 --- a/koyeb/api/models/create_account_request.py +++ b/koyeb/api/models/create_account_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/create_app.py b/koyeb/api/models/create_app.py index 9e6b8fee..1db9a28f 100644 --- a/koyeb/api/models/create_app.py +++ b/koyeb/api/models/create_app.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/create_app_reply.py b/koyeb/api/models/create_app_reply.py index 66ac27e2..9c354f3b 100644 --- a/koyeb/api/models/create_app_reply.py +++ b/koyeb/api/models/create_app_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/create_archive.py b/koyeb/api/models/create_archive.py index 22f983d5..f180e596 100644 --- a/koyeb/api/models/create_archive.py +++ b/koyeb/api/models/create_archive.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/create_archive_reply.py b/koyeb/api/models/create_archive_reply.py index 71e472b9..221e9813 100644 --- a/koyeb/api/models/create_archive_reply.py +++ b/koyeb/api/models/create_archive_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/create_budget_reply.py b/koyeb/api/models/create_budget_reply.py index 7112cac4..2c8a4e95 100644 --- a/koyeb/api/models/create_budget_reply.py +++ b/koyeb/api/models/create_budget_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/create_compose.py b/koyeb/api/models/create_compose.py index 46e84a64..7c2838e3 100644 --- a/koyeb/api/models/create_compose.py +++ b/koyeb/api/models/create_compose.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/create_credential.py b/koyeb/api/models/create_credential.py index 4355280b..60727156 100644 --- a/koyeb/api/models/create_credential.py +++ b/koyeb/api/models/create_credential.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/create_credential_reply.py b/koyeb/api/models/create_credential_reply.py index 7b1cbbd0..8c829811 100644 --- a/koyeb/api/models/create_credential_reply.py +++ b/koyeb/api/models/create_credential_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/create_domain.py b/koyeb/api/models/create_domain.py index 84db053f..0538d9d3 100644 --- a/koyeb/api/models/create_domain.py +++ b/koyeb/api/models/create_domain.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/create_domain_reply.py b/koyeb/api/models/create_domain_reply.py index d8ce4cfd..dc5cbbd7 100644 --- a/koyeb/api/models/create_domain_reply.py +++ b/koyeb/api/models/create_domain_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/create_instance_snapshot_reply.py b/koyeb/api/models/create_instance_snapshot_reply.py index e73898dc..07ad65d2 100644 --- a/koyeb/api/models/create_instance_snapshot_reply.py +++ b/koyeb/api/models/create_instance_snapshot_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/create_instance_snapshot_request.py b/koyeb/api/models/create_instance_snapshot_request.py index 47318514..46da850f 100644 --- a/koyeb/api/models/create_instance_snapshot_request.py +++ b/koyeb/api/models/create_instance_snapshot_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/create_organization_invitation_reply.py b/koyeb/api/models/create_organization_invitation_reply.py index 10a44a76..32de3190 100644 --- a/koyeb/api/models/create_organization_invitation_reply.py +++ b/koyeb/api/models/create_organization_invitation_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/create_organization_invitation_request.py b/koyeb/api/models/create_organization_invitation_request.py index 0bf58fc4..8984c8ca 100644 --- a/koyeb/api/models/create_organization_invitation_request.py +++ b/koyeb/api/models/create_organization_invitation_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/create_organization_reply.py b/koyeb/api/models/create_organization_reply.py index 510801f8..2d097b50 100644 --- a/koyeb/api/models/create_organization_reply.py +++ b/koyeb/api/models/create_organization_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/create_organization_request.py b/koyeb/api/models/create_organization_request.py index e56892d4..5f9b4ba1 100644 --- a/koyeb/api/models/create_organization_request.py +++ b/koyeb/api/models/create_organization_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/create_payment_authorization_reply.py b/koyeb/api/models/create_payment_authorization_reply.py index 487a381c..51df6759 100644 --- a/koyeb/api/models/create_payment_authorization_reply.py +++ b/koyeb/api/models/create_payment_authorization_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/create_persistent_volume_reply.py b/koyeb/api/models/create_persistent_volume_reply.py index a1b5b5cc..9891baaa 100644 --- a/koyeb/api/models/create_persistent_volume_reply.py +++ b/koyeb/api/models/create_persistent_volume_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/create_persistent_volume_request.py b/koyeb/api/models/create_persistent_volume_request.py index 5a4d17d3..add8eff0 100644 --- a/koyeb/api/models/create_persistent_volume_request.py +++ b/koyeb/api/models/create_persistent_volume_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/create_project.py b/koyeb/api/models/create_project.py index 0bde34b8..77d8c26c 100644 --- a/koyeb/api/models/create_project.py +++ b/koyeb/api/models/create_project.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/create_project_reply.py b/koyeb/api/models/create_project_reply.py index 622501a4..6252e45d 100644 --- a/koyeb/api/models/create_project_reply.py +++ b/koyeb/api/models/create_project_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/create_secret.py b/koyeb/api/models/create_secret.py index 89a9253e..d7d00446 100644 --- a/koyeb/api/models/create_secret.py +++ b/koyeb/api/models/create_secret.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/create_secret_reply.py b/koyeb/api/models/create_secret_reply.py index e1633360..c303ac27 100644 --- a/koyeb/api/models/create_secret_reply.py +++ b/koyeb/api/models/create_secret_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/create_service.py b/koyeb/api/models/create_service.py index ca29b476..5825a03e 100644 --- a/koyeb/api/models/create_service.py +++ b/koyeb/api/models/create_service.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/create_service_pool.py b/koyeb/api/models/create_service_pool.py index c128942f..787c5637 100644 --- a/koyeb/api/models/create_service_pool.py +++ b/koyeb/api/models/create_service_pool.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/create_service_pool_reply.py b/koyeb/api/models/create_service_pool_reply.py index b5df058d..ae7193dd 100644 --- a/koyeb/api/models/create_service_pool_reply.py +++ b/koyeb/api/models/create_service_pool_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/create_service_reply.py b/koyeb/api/models/create_service_reply.py index f1d6a659..a533247e 100644 --- a/koyeb/api/models/create_service_reply.py +++ b/koyeb/api/models/create_service_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/create_snapshot_reply.py b/koyeb/api/models/create_snapshot_reply.py index db0dc587..5dcc976a 100644 --- a/koyeb/api/models/create_snapshot_reply.py +++ b/koyeb/api/models/create_snapshot_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/create_snapshot_request.py b/koyeb/api/models/create_snapshot_request.py index 7a73ac71..79b90549 100644 --- a/koyeb/api/models/create_snapshot_request.py +++ b/koyeb/api/models/create_snapshot_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/create_stage_attempt_request.py b/koyeb/api/models/create_stage_attempt_request.py index 8e8d1ef4..5c12503d 100644 --- a/koyeb/api/models/create_stage_attempt_request.py +++ b/koyeb/api/models/create_stage_attempt_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/credential.py b/koyeb/api/models/credential.py index 90a2452f..2135a026 100644 --- a/koyeb/api/models/credential.py +++ b/koyeb/api/models/credential.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/credential_type.py b/koyeb/api/models/credential_type.py index 3d835bd3..c3679dd7 100644 --- a/koyeb/api/models/credential_type.py +++ b/koyeb/api/models/credential_type.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/database_deployment_metadata.py b/koyeb/api/models/database_deployment_metadata.py index 81fadd5f..d03338e9 100644 --- a/koyeb/api/models/database_deployment_metadata.py +++ b/koyeb/api/models/database_deployment_metadata.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/database_role_password.py b/koyeb/api/models/database_role_password.py index c5205862..08850fe2 100644 --- a/koyeb/api/models/database_role_password.py +++ b/koyeb/api/models/database_role_password.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/database_source.py b/koyeb/api/models/database_source.py index 22c3266d..1ff339a9 100644 --- a/koyeb/api/models/database_source.py +++ b/koyeb/api/models/database_source.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/database_usage.py b/koyeb/api/models/database_usage.py index 67210716..7410cdca 100644 --- a/koyeb/api/models/database_usage.py +++ b/koyeb/api/models/database_usage.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/database_usage_details.py b/koyeb/api/models/database_usage_details.py index 12ba6e3c..51d84607 100644 --- a/koyeb/api/models/database_usage_details.py +++ b/koyeb/api/models/database_usage_details.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/datacenter_list_item.py b/koyeb/api/models/datacenter_list_item.py index 3b395b3b..4c08a728 100644 --- a/koyeb/api/models/datacenter_list_item.py +++ b/koyeb/api/models/datacenter_list_item.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/deactivate_organization_reply.py b/koyeb/api/models/deactivate_organization_reply.py index 21598d56..d7254396 100644 --- a/koyeb/api/models/deactivate_organization_reply.py +++ b/koyeb/api/models/deactivate_organization_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/deactivate_organization_request.py b/koyeb/api/models/deactivate_organization_request.py index 14d6bbd5..929b07c3 100644 --- a/koyeb/api/models/deactivate_organization_request.py +++ b/koyeb/api/models/deactivate_organization_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/declare_stage_progress_request.py b/koyeb/api/models/declare_stage_progress_request.py index a549ad10..7dd2505c 100644 --- a/koyeb/api/models/declare_stage_progress_request.py +++ b/koyeb/api/models/declare_stage_progress_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/declare_step_progress_request.py b/koyeb/api/models/declare_step_progress_request.py index 05404863..269a3379 100644 --- a/koyeb/api/models/declare_step_progress_request.py +++ b/koyeb/api/models/declare_step_progress_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/decline_organization_invitation_reply.py b/koyeb/api/models/decline_organization_invitation_reply.py index 5444850f..83f0640c 100644 --- a/koyeb/api/models/decline_organization_invitation_reply.py +++ b/koyeb/api/models/decline_organization_invitation_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/delete_instance_snapshot_reply.py b/koyeb/api/models/delete_instance_snapshot_reply.py index 5b557d07..6d8d8877 100644 --- a/koyeb/api/models/delete_instance_snapshot_reply.py +++ b/koyeb/api/models/delete_instance_snapshot_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/delete_organization_reply.py b/koyeb/api/models/delete_organization_reply.py index 9d68e378..57d755e3 100644 --- a/koyeb/api/models/delete_organization_reply.py +++ b/koyeb/api/models/delete_organization_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/delete_persistent_volume_reply.py b/koyeb/api/models/delete_persistent_volume_reply.py index 08d4ab67..6c231ccd 100644 --- a/koyeb/api/models/delete_persistent_volume_reply.py +++ b/koyeb/api/models/delete_persistent_volume_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/delete_snapshot_reply.py b/koyeb/api/models/delete_snapshot_reply.py index 6e2ac1fd..abd2aec4 100644 --- a/koyeb/api/models/delete_snapshot_reply.py +++ b/koyeb/api/models/delete_snapshot_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/delete_user_reply.py b/koyeb/api/models/delete_user_reply.py index fd67f7ef..59695604 100644 --- a/koyeb/api/models/delete_user_reply.py +++ b/koyeb/api/models/delete_user_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/deployment.py b/koyeb/api/models/deployment.py index ee15826e..1ac35cf5 100644 --- a/koyeb/api/models/deployment.py +++ b/koyeb/api/models/deployment.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/deployment_database_info.py b/koyeb/api/models/deployment_database_info.py index 4ee06612..3849d50f 100644 --- a/koyeb/api/models/deployment_database_info.py +++ b/koyeb/api/models/deployment_database_info.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/deployment_definition.py b/koyeb/api/models/deployment_definition.py index 3c59ca21..3d1e4aff 100644 --- a/koyeb/api/models/deployment_definition.py +++ b/koyeb/api/models/deployment_definition.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -17,7 +17,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional from koyeb.api.models.archive_source import ArchiveSource from koyeb.api.models.config_file import ConfigFile @@ -65,6 +65,7 @@ class DeploymentDefinition(BaseModel): skip_cache: Optional[StrictBool] = None mesh: Optional[DeploymentMesh] = DeploymentMesh.DEPLOYMENT_MESH_AUTO network_policy: Optional[NetworkPolicy] = None + kill_timeout_secs: Optional[StrictInt] = None docker: Optional[DockerSource] = None git: Optional[GitSource] = None database: Optional[DatabaseSource] = None @@ -86,6 +87,7 @@ class DeploymentDefinition(BaseModel): "skip_cache", "mesh", "network_policy", + "kill_timeout_secs", "docker", "git", "database", @@ -294,6 +296,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "network_policy": NetworkPolicy.from_dict(obj["network_policy"]) if obj.get("network_policy") is not None else None, + "kill_timeout_secs": obj.get("kill_timeout_secs"), "docker": DockerSource.from_dict(obj["docker"]) if obj.get("docker") is not None else None, diff --git a/koyeb/api/models/deployment_definition_type.py b/koyeb/api/models/deployment_definition_type.py index c3014a7e..032f48a1 100644 --- a/koyeb/api/models/deployment_definition_type.py +++ b/koyeb/api/models/deployment_definition_type.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/deployment_env.py b/koyeb/api/models/deployment_env.py index 1ecef1e5..baab50c6 100644 --- a/koyeb/api/models/deployment_env.py +++ b/koyeb/api/models/deployment_env.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/deployment_event.py b/koyeb/api/models/deployment_event.py index 00cd2493..58a58b33 100644 --- a/koyeb/api/models/deployment_event.py +++ b/koyeb/api/models/deployment_event.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/deployment_health_check.py b/koyeb/api/models/deployment_health_check.py index 700dd915..9e2bb384 100644 --- a/koyeb/api/models/deployment_health_check.py +++ b/koyeb/api/models/deployment_health_check.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/deployment_instance_type.py b/koyeb/api/models/deployment_instance_type.py index 9c9c866e..19317c52 100644 --- a/koyeb/api/models/deployment_instance_type.py +++ b/koyeb/api/models/deployment_instance_type.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/deployment_list_item.py b/koyeb/api/models/deployment_list_item.py index 5b293b49..1bb6fcd2 100644 --- a/koyeb/api/models/deployment_list_item.py +++ b/koyeb/api/models/deployment_list_item.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/deployment_mesh.py b/koyeb/api/models/deployment_mesh.py index 6b9ce078..1aaabe3e 100644 --- a/koyeb/api/models/deployment_mesh.py +++ b/koyeb/api/models/deployment_mesh.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/deployment_metadata.py b/koyeb/api/models/deployment_metadata.py index 80c0a56d..e7284fe4 100644 --- a/koyeb/api/models/deployment_metadata.py +++ b/koyeb/api/models/deployment_metadata.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/deployment_neon_postgres_database_info.py b/koyeb/api/models/deployment_neon_postgres_database_info.py index 9ff82abd..a9a46eb9 100644 --- a/koyeb/api/models/deployment_neon_postgres_database_info.py +++ b/koyeb/api/models/deployment_neon_postgres_database_info.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/deployment_neon_postgres_database_info_role.py b/koyeb/api/models/deployment_neon_postgres_database_info_role.py index 3fb284df..e5878793 100644 --- a/koyeb/api/models/deployment_neon_postgres_database_info_role.py +++ b/koyeb/api/models/deployment_neon_postgres_database_info_role.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/deployment_port.py b/koyeb/api/models/deployment_port.py index c3f06c05..9fa8f690 100644 --- a/koyeb/api/models/deployment_port.py +++ b/koyeb/api/models/deployment_port.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/deployment_provisioning_info.py b/koyeb/api/models/deployment_provisioning_info.py index f5e9dd7c..96a59de3 100644 --- a/koyeb/api/models/deployment_provisioning_info.py +++ b/koyeb/api/models/deployment_provisioning_info.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/deployment_provisioning_info_stage.py b/koyeb/api/models/deployment_provisioning_info_stage.py index cae93f70..d19da97e 100644 --- a/koyeb/api/models/deployment_provisioning_info_stage.py +++ b/koyeb/api/models/deployment_provisioning_info_stage.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/deployment_provisioning_info_stage_build_attempt.py b/koyeb/api/models/deployment_provisioning_info_stage_build_attempt.py index dbf0156b..f7614277 100644 --- a/koyeb/api/models/deployment_provisioning_info_stage_build_attempt.py +++ b/koyeb/api/models/deployment_provisioning_info_stage_build_attempt.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/deployment_provisioning_info_stage_build_attempt_build_step.py b/koyeb/api/models/deployment_provisioning_info_stage_build_attempt_build_step.py index d446f408..116efc48 100644 --- a/koyeb/api/models/deployment_provisioning_info_stage_build_attempt_build_step.py +++ b/koyeb/api/models/deployment_provisioning_info_stage_build_attempt_build_step.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/deployment_provisioning_info_stage_status.py b/koyeb/api/models/deployment_provisioning_info_stage_status.py index 837e5851..db021893 100644 --- a/koyeb/api/models/deployment_provisioning_info_stage_status.py +++ b/koyeb/api/models/deployment_provisioning_info_stage_status.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/deployment_proxy_port.py b/koyeb/api/models/deployment_proxy_port.py index 66deee92..8a9d2cdd 100644 --- a/koyeb/api/models/deployment_proxy_port.py +++ b/koyeb/api/models/deployment_proxy_port.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/deployment_proxy_port_metadata.py b/koyeb/api/models/deployment_proxy_port_metadata.py index 3fab2d0d..96504bd9 100644 --- a/koyeb/api/models/deployment_proxy_port_metadata.py +++ b/koyeb/api/models/deployment_proxy_port_metadata.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/deployment_role.py b/koyeb/api/models/deployment_role.py index 649f75f0..b4052032 100644 --- a/koyeb/api/models/deployment_role.py +++ b/koyeb/api/models/deployment_role.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/deployment_route.py b/koyeb/api/models/deployment_route.py index 36472793..87390c47 100644 --- a/koyeb/api/models/deployment_route.py +++ b/koyeb/api/models/deployment_route.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/deployment_scaling.py b/koyeb/api/models/deployment_scaling.py index ff8db400..b9ebb9cc 100644 --- a/koyeb/api/models/deployment_scaling.py +++ b/koyeb/api/models/deployment_scaling.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/deployment_scaling_target.py b/koyeb/api/models/deployment_scaling_target.py index d6536441..fc553f7b 100644 --- a/koyeb/api/models/deployment_scaling_target.py +++ b/koyeb/api/models/deployment_scaling_target.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/deployment_scaling_target_average_cpu.py b/koyeb/api/models/deployment_scaling_target_average_cpu.py index 21ce94ae..1dec7dea 100644 --- a/koyeb/api/models/deployment_scaling_target_average_cpu.py +++ b/koyeb/api/models/deployment_scaling_target_average_cpu.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/deployment_scaling_target_average_mem.py b/koyeb/api/models/deployment_scaling_target_average_mem.py index 0193838e..4670c8bb 100644 --- a/koyeb/api/models/deployment_scaling_target_average_mem.py +++ b/koyeb/api/models/deployment_scaling_target_average_mem.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/deployment_scaling_target_concurrent_requests.py b/koyeb/api/models/deployment_scaling_target_concurrent_requests.py index a43c46e0..c271defd 100644 --- a/koyeb/api/models/deployment_scaling_target_concurrent_requests.py +++ b/koyeb/api/models/deployment_scaling_target_concurrent_requests.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/deployment_scaling_target_requests_per_second.py b/koyeb/api/models/deployment_scaling_target_requests_per_second.py index 5d74a068..349b82ac 100644 --- a/koyeb/api/models/deployment_scaling_target_requests_per_second.py +++ b/koyeb/api/models/deployment_scaling_target_requests_per_second.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/deployment_scaling_target_requests_response_time.py b/koyeb/api/models/deployment_scaling_target_requests_response_time.py index 2865cfd1..f07f80da 100644 --- a/koyeb/api/models/deployment_scaling_target_requests_response_time.py +++ b/koyeb/api/models/deployment_scaling_target_requests_response_time.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/deployment_scaling_target_sleep_idle_delay.py b/koyeb/api/models/deployment_scaling_target_sleep_idle_delay.py index c5738f84..74c6151a 100644 --- a/koyeb/api/models/deployment_scaling_target_sleep_idle_delay.py +++ b/koyeb/api/models/deployment_scaling_target_sleep_idle_delay.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/deployment_status.py b/koyeb/api/models/deployment_status.py index c4b733c9..64db15d1 100644 --- a/koyeb/api/models/deployment_status.py +++ b/koyeb/api/models/deployment_status.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/deployment_strategy.py b/koyeb/api/models/deployment_strategy.py index 6813e718..dc7024c9 100644 --- a/koyeb/api/models/deployment_strategy.py +++ b/koyeb/api/models/deployment_strategy.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/deployment_strategy_type.py b/koyeb/api/models/deployment_strategy_type.py index 3c82cbd1..ac2ac3fa 100644 --- a/koyeb/api/models/deployment_strategy_type.py +++ b/koyeb/api/models/deployment_strategy_type.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/deployment_volume.py b/koyeb/api/models/deployment_volume.py index b0c27f45..49934fab 100644 --- a/koyeb/api/models/deployment_volume.py +++ b/koyeb/api/models/deployment_volume.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/desired_deployment.py b/koyeb/api/models/desired_deployment.py index f7af2aee..c3763876 100644 --- a/koyeb/api/models/desired_deployment.py +++ b/koyeb/api/models/desired_deployment.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/desired_deployment_group.py b/koyeb/api/models/desired_deployment_group.py index 49e7d8ed..d4ac8787 100644 --- a/koyeb/api/models/desired_deployment_group.py +++ b/koyeb/api/models/desired_deployment_group.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/digital_ocean_registry_configuration.py b/koyeb/api/models/digital_ocean_registry_configuration.py index 814943ff..b9e2fe56 100644 --- a/koyeb/api/models/digital_ocean_registry_configuration.py +++ b/koyeb/api/models/digital_ocean_registry_configuration.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/discourse_auth_reply.py b/koyeb/api/models/discourse_auth_reply.py index ac8199be..15a6c014 100644 --- a/koyeb/api/models/discourse_auth_reply.py +++ b/koyeb/api/models/discourse_auth_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/discourse_auth_request.py b/koyeb/api/models/discourse_auth_request.py index 857708e1..310336b6 100644 --- a/koyeb/api/models/discourse_auth_request.py +++ b/koyeb/api/models/discourse_auth_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/docker_builder.py b/koyeb/api/models/docker_builder.py index 4dd66bfd..c78c736a 100644 --- a/koyeb/api/models/docker_builder.py +++ b/koyeb/api/models/docker_builder.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/docker_deployment_metadata.py b/koyeb/api/models/docker_deployment_metadata.py index 9d466126..5c8553db 100644 --- a/koyeb/api/models/docker_deployment_metadata.py +++ b/koyeb/api/models/docker_deployment_metadata.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/docker_hub_registry_configuration.py b/koyeb/api/models/docker_hub_registry_configuration.py index 18b48c74..62dc525f 100644 --- a/koyeb/api/models/docker_hub_registry_configuration.py +++ b/koyeb/api/models/docker_hub_registry_configuration.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/docker_source.py b/koyeb/api/models/docker_source.py index b6793b6a..defc9dd1 100644 --- a/koyeb/api/models/docker_source.py +++ b/koyeb/api/models/docker_source.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/domain.py b/koyeb/api/models/domain.py index 15a8f155..06e8351e 100644 --- a/koyeb/api/models/domain.py +++ b/koyeb/api/models/domain.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/domain_load_balancer_koyeb.py b/koyeb/api/models/domain_load_balancer_koyeb.py index a23d93d1..eebde5ff 100644 --- a/koyeb/api/models/domain_load_balancer_koyeb.py +++ b/koyeb/api/models/domain_load_balancer_koyeb.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/domain_load_balancer_quotas.py b/koyeb/api/models/domain_load_balancer_quotas.py index f103cb75..5bca4122 100644 --- a/koyeb/api/models/domain_load_balancer_quotas.py +++ b/koyeb/api/models/domain_load_balancer_quotas.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/domain_status.py b/koyeb/api/models/domain_status.py index 8abb49ab..a3565275 100644 --- a/koyeb/api/models/domain_status.py +++ b/koyeb/api/models/domain_status.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/domain_type.py b/koyeb/api/models/domain_type.py index 2a709294..573ae4c4 100644 --- a/koyeb/api/models/domain_type.py +++ b/koyeb/api/models/domain_type.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/domains_summary.py b/koyeb/api/models/domains_summary.py index 98b06194..f990be40 100644 --- a/koyeb/api/models/domains_summary.py +++ b/koyeb/api/models/domains_summary.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/egress_policy.py b/koyeb/api/models/egress_policy.py index 4f35024a..005df017 100644 --- a/koyeb/api/models/egress_policy.py +++ b/koyeb/api/models/egress_policy.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/egress_policy_mode.py b/koyeb/api/models/egress_policy_mode.py index 968dc260..9b65aae1 100644 --- a/koyeb/api/models/egress_policy_mode.py +++ b/koyeb/api/models/egress_policy_mode.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/env.py b/koyeb/api/models/env.py index cee7b64a..ebf36e7c 100644 --- a/koyeb/api/models/env.py +++ b/koyeb/api/models/env.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/error.py b/koyeb/api/models/error.py index ec2fe905..81a90a3c 100644 --- a/koyeb/api/models/error.py +++ b/koyeb/api/models/error.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/error_field.py b/koyeb/api/models/error_field.py index 848aca13..94d6b0b7 100644 --- a/koyeb/api/models/error_field.py +++ b/koyeb/api/models/error_field.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/error_with_fields.py b/koyeb/api/models/error_with_fields.py index 440b1ae6..6b306b73 100644 --- a/koyeb/api/models/error_with_fields.py +++ b/koyeb/api/models/error_with_fields.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/exec_command_io.py b/koyeb/api/models/exec_command_io.py index 1db0c6f7..d8a0a351 100644 --- a/koyeb/api/models/exec_command_io.py +++ b/koyeb/api/models/exec_command_io.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/exec_command_reply.py b/koyeb/api/models/exec_command_reply.py index afe9d684..87ad6628 100644 --- a/koyeb/api/models/exec_command_reply.py +++ b/koyeb/api/models/exec_command_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/exec_command_request_body.py b/koyeb/api/models/exec_command_request_body.py index 9d46edca..713b7c80 100644 --- a/koyeb/api/models/exec_command_request_body.py +++ b/koyeb/api/models/exec_command_request_body.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/exec_command_request_id_type.py b/koyeb/api/models/exec_command_request_id_type.py index f6deb51f..d9074d71 100644 --- a/koyeb/api/models/exec_command_request_id_type.py +++ b/koyeb/api/models/exec_command_request_id_type.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/exec_command_request_terminal_size.py b/koyeb/api/models/exec_command_request_terminal_size.py index 5f6f41ff..3ca721f4 100644 --- a/koyeb/api/models/exec_command_request_terminal_size.py +++ b/koyeb/api/models/exec_command_request_terminal_size.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/gcp_container_registry_configuration.py b/koyeb/api/models/gcp_container_registry_configuration.py index 527bf173..951a8c6c 100644 --- a/koyeb/api/models/gcp_container_registry_configuration.py +++ b/koyeb/api/models/gcp_container_registry_configuration.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/get_app_reply.py b/koyeb/api/models/get_app_reply.py index 5e653502..f42ead51 100644 --- a/koyeb/api/models/get_app_reply.py +++ b/koyeb/api/models/get_app_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/get_archive_reply.py b/koyeb/api/models/get_archive_reply.py new file mode 100644 index 00000000..b5f91101 --- /dev/null +++ b/koyeb/api/models/get_archive_reply.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from koyeb.api.models.archive import Archive +from typing import Optional, Set +from typing_extensions import Self +from pydantic_core import to_jsonable_python + + +class GetArchiveReply(BaseModel): + """ + GetArchiveReply + """ # noqa: E501 + + archive: Optional[Archive] = None + __properties: ClassVar[List[str]] = ["archive"] + + model_config = ConfigDict( + validate_by_name=True, + validate_by_alias=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(to_jsonable_python(self.to_dict())) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of GetArchiveReply from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of archive + if self.archive: + _dict["archive"] = self.archive.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of GetArchiveReply from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "archive": Archive.from_dict(obj["archive"]) + if obj.get("archive") is not None + else None + } + ) + return _obj diff --git a/koyeb/api/models/get_budget_reply.py b/koyeb/api/models/get_budget_reply.py index 510af54f..7afdeb76 100644 --- a/koyeb/api/models/get_budget_reply.py +++ b/koyeb/api/models/get_budget_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/get_catalog_instance_reply.py b/koyeb/api/models/get_catalog_instance_reply.py index d0e0b9e6..c3f9312e 100644 --- a/koyeb/api/models/get_catalog_instance_reply.py +++ b/koyeb/api/models/get_catalog_instance_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/get_credential_reply.py b/koyeb/api/models/get_credential_reply.py index b7dba9bb..cef547f2 100644 --- a/koyeb/api/models/get_credential_reply.py +++ b/koyeb/api/models/get_credential_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/get_deployment_reply.py b/koyeb/api/models/get_deployment_reply.py index 77db2f00..21e579c6 100644 --- a/koyeb/api/models/get_deployment_reply.py +++ b/koyeb/api/models/get_deployment_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/get_deployment_scaling_reply.py b/koyeb/api/models/get_deployment_scaling_reply.py index 4d7ac556..47e927ea 100644 --- a/koyeb/api/models/get_deployment_scaling_reply.py +++ b/koyeb/api/models/get_deployment_scaling_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/get_deployment_scaling_reply_item.py b/koyeb/api/models/get_deployment_scaling_reply_item.py index da363ff0..c1632000 100644 --- a/koyeb/api/models/get_deployment_scaling_reply_item.py +++ b/koyeb/api/models/get_deployment_scaling_reply_item.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/get_domain_reply.py b/koyeb/api/models/get_domain_reply.py index 9a925c72..c90ab1a6 100644 --- a/koyeb/api/models/get_domain_reply.py +++ b/koyeb/api/models/get_domain_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/get_github_installation_reply.py b/koyeb/api/models/get_github_installation_reply.py index 81a7b516..a64618ae 100644 --- a/koyeb/api/models/get_github_installation_reply.py +++ b/koyeb/api/models/get_github_installation_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/get_idenfy_token_reply.py b/koyeb/api/models/get_idenfy_token_reply.py index fe8ac94e..9fce4b99 100644 --- a/koyeb/api/models/get_idenfy_token_reply.py +++ b/koyeb/api/models/get_idenfy_token_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/get_instance_reply.py b/koyeb/api/models/get_instance_reply.py index 3435f960..07583f5f 100644 --- a/koyeb/api/models/get_instance_reply.py +++ b/koyeb/api/models/get_instance_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/get_instance_snapshot_reply.py b/koyeb/api/models/get_instance_snapshot_reply.py index 30e93415..b4a63e9f 100644 --- a/koyeb/api/models/get_instance_snapshot_reply.py +++ b/koyeb/api/models/get_instance_snapshot_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/get_intercom_profile_reply.py b/koyeb/api/models/get_intercom_profile_reply.py index 1fad5419..22356241 100644 --- a/koyeb/api/models/get_intercom_profile_reply.py +++ b/koyeb/api/models/get_intercom_profile_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/get_metrics_reply.py b/koyeb/api/models/get_metrics_reply.py index 66d54ea1..1f515195 100644 --- a/koyeb/api/models/get_metrics_reply.py +++ b/koyeb/api/models/get_metrics_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/get_metrics_reply_metric.py b/koyeb/api/models/get_metrics_reply_metric.py index 9e09b487..328af72b 100644 --- a/koyeb/api/models/get_metrics_reply_metric.py +++ b/koyeb/api/models/get_metrics_reply_metric.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/get_o_auth_options_reply.py b/koyeb/api/models/get_o_auth_options_reply.py index 4eb1e61b..05412d9e 100644 --- a/koyeb/api/models/get_o_auth_options_reply.py +++ b/koyeb/api/models/get_o_auth_options_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/get_organization_invitation_reply.py b/koyeb/api/models/get_organization_invitation_reply.py index 89ed788e..7a77f42c 100644 --- a/koyeb/api/models/get_organization_invitation_reply.py +++ b/koyeb/api/models/get_organization_invitation_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/get_organization_quotas_usage_reply.py b/koyeb/api/models/get_organization_quotas_usage_reply.py index fd21a2e1..6834d202 100644 --- a/koyeb/api/models/get_organization_quotas_usage_reply.py +++ b/koyeb/api/models/get_organization_quotas_usage_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/get_organization_reply.py b/koyeb/api/models/get_organization_reply.py index 08a146b7..4bc69adc 100644 --- a/koyeb/api/models/get_organization_reply.py +++ b/koyeb/api/models/get_organization_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/get_organization_summary_reply.py b/koyeb/api/models/get_organization_summary_reply.py index ef030579..e5208ea6 100644 --- a/koyeb/api/models/get_organization_summary_reply.py +++ b/koyeb/api/models/get_organization_summary_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/get_organization_usage_details_reply.py b/koyeb/api/models/get_organization_usage_details_reply.py index 49d66c57..7baa0804 100644 --- a/koyeb/api/models/get_organization_usage_details_reply.py +++ b/koyeb/api/models/get_organization_usage_details_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/get_organization_usage_reply.py b/koyeb/api/models/get_organization_usage_reply.py index c3cd84b7..3ddf6eeb 100644 --- a/koyeb/api/models/get_organization_usage_reply.py +++ b/koyeb/api/models/get_organization_usage_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/get_payment_method_reply.py b/koyeb/api/models/get_payment_method_reply.py index 06095940..6383110a 100644 --- a/koyeb/api/models/get_payment_method_reply.py +++ b/koyeb/api/models/get_payment_method_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/get_persistent_volume_reply.py b/koyeb/api/models/get_persistent_volume_reply.py index 7412f1f1..36ec0321 100644 --- a/koyeb/api/models/get_persistent_volume_reply.py +++ b/koyeb/api/models/get_persistent_volume_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/get_pool_claim_reply.py b/koyeb/api/models/get_pool_claim_reply.py index 6cf839b9..09df190b 100644 --- a/koyeb/api/models/get_pool_claim_reply.py +++ b/koyeb/api/models/get_pool_claim_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/get_project_reply.py b/koyeb/api/models/get_project_reply.py index bc813765..4b2bf837 100644 --- a/koyeb/api/models/get_project_reply.py +++ b/koyeb/api/models/get_project_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/get_quotas_reply.py b/koyeb/api/models/get_quotas_reply.py index e5dbdd98..91c3efaf 100644 --- a/koyeb/api/models/get_quotas_reply.py +++ b/koyeb/api/models/get_quotas_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/get_region_reply.py b/koyeb/api/models/get_region_reply.py index 8bd402e2..abdfd214 100644 --- a/koyeb/api/models/get_region_reply.py +++ b/koyeb/api/models/get_region_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/get_regional_deployment_reply.py b/koyeb/api/models/get_regional_deployment_reply.py index 03d8a8b6..201a4ddc 100644 --- a/koyeb/api/models/get_regional_deployment_reply.py +++ b/koyeb/api/models/get_regional_deployment_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/get_secret_reply.py b/koyeb/api/models/get_secret_reply.py index a86db90f..0af58a9a 100644 --- a/koyeb/api/models/get_secret_reply.py +++ b/koyeb/api/models/get_secret_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/get_service_pool_reply.py b/koyeb/api/models/get_service_pool_reply.py index b41e7105..a275503c 100644 --- a/koyeb/api/models/get_service_pool_reply.py +++ b/koyeb/api/models/get_service_pool_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/get_service_reply.py b/koyeb/api/models/get_service_reply.py index 76ac040a..5df5f0e2 100644 --- a/koyeb/api/models/get_service_reply.py +++ b/koyeb/api/models/get_service_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/get_service_scaling_reply.py b/koyeb/api/models/get_service_scaling_reply.py index bc8fd771..770036aa 100644 --- a/koyeb/api/models/get_service_scaling_reply.py +++ b/koyeb/api/models/get_service_scaling_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/get_snapshot_reply.py b/koyeb/api/models/get_snapshot_reply.py index 3330f261..d6ea1be5 100644 --- a/koyeb/api/models/get_snapshot_reply.py +++ b/koyeb/api/models/get_snapshot_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/get_subscription_reply.py b/koyeb/api/models/get_subscription_reply.py index 62ab727e..4f2c48f5 100644 --- a/koyeb/api/models/get_subscription_reply.py +++ b/koyeb/api/models/get_subscription_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/get_user_organization_invitation_reply.py b/koyeb/api/models/get_user_organization_invitation_reply.py index 978d5662..0edf1122 100644 --- a/koyeb/api/models/get_user_organization_invitation_reply.py +++ b/koyeb/api/models/get_user_organization_invitation_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/get_user_settings_reply.py b/koyeb/api/models/get_user_settings_reply.py index 8fabf2de..e6339d82 100644 --- a/koyeb/api/models/get_user_settings_reply.py +++ b/koyeb/api/models/get_user_settings_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/git_deployment_metadata.py b/koyeb/api/models/git_deployment_metadata.py index 7b6f4cc2..bff0d205 100644 --- a/koyeb/api/models/git_deployment_metadata.py +++ b/koyeb/api/models/git_deployment_metadata.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/git_env_deployment_metadata.py b/koyeb/api/models/git_env_deployment_metadata.py index 095fb60f..2b839337 100644 --- a/koyeb/api/models/git_env_deployment_metadata.py +++ b/koyeb/api/models/git_env_deployment_metadata.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/git_hub_registry_configuration.py b/koyeb/api/models/git_hub_registry_configuration.py index 61e5d778..ea87f2e4 100644 --- a/koyeb/api/models/git_hub_registry_configuration.py +++ b/koyeb/api/models/git_hub_registry_configuration.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/git_lab_registry_configuration.py b/koyeb/api/models/git_lab_registry_configuration.py index 656f77bd..37f76535 100644 --- a/koyeb/api/models/git_lab_registry_configuration.py +++ b/koyeb/api/models/git_lab_registry_configuration.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/git_source.py b/koyeb/api/models/git_source.py index 9bb8fe67..474bcad4 100644 --- a/koyeb/api/models/git_source.py +++ b/koyeb/api/models/git_source.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -48,6 +48,10 @@ class GitSource(BaseModel): default=None, description='Credentials can come from a specific source or default to using Github (when unset or set to "github").', ) + skip_submodules: Optional[StrictBool] = Field( + default=None, + description="A flag to skip initializing git submodules when cloning the repository.", + ) __properties: ClassVar[List[str]] = [ "repository", "branch", @@ -60,6 +64,7 @@ class GitSource(BaseModel): "buildpack", "docker", "credential_source", + "skip_submodules", ] model_config = ConfigDict( @@ -133,6 +138,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("docker") is not None else None, "credential_source": obj.get("credential_source"), + "skip_submodules": obj.get("skip_submodules"), } ) return _obj diff --git a/koyeb/api/models/github_installation_reply.py b/koyeb/api/models/github_installation_reply.py index 7ff07785..c88570a9 100644 --- a/koyeb/api/models/github_installation_reply.py +++ b/koyeb/api/models/github_installation_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/github_installation_request.py b/koyeb/api/models/github_installation_request.py index 3fe192b8..c92fe1b0 100644 --- a/koyeb/api/models/github_installation_request.py +++ b/koyeb/api/models/github_installation_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/google_protobuf_any.py b/koyeb/api/models/google_protobuf_any.py index 43c57cab..df4e60a4 100644 --- a/koyeb/api/models/google_protobuf_any.py +++ b/koyeb/api/models/google_protobuf_any.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/google_protobuf_null_value.py b/koyeb/api/models/google_protobuf_null_value.py index 0245ec31..ef88559c 100644 --- a/koyeb/api/models/google_protobuf_null_value.py +++ b/koyeb/api/models/google_protobuf_null_value.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/google_rpc_status.py b/koyeb/api/models/google_rpc_status.py index bd07f382..9899cb5f 100644 --- a/koyeb/api/models/google_rpc_status.py +++ b/koyeb/api/models/google_rpc_status.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/grpc_health_check.py b/koyeb/api/models/grpc_health_check.py index 8471078b..3caac80e 100644 --- a/koyeb/api/models/grpc_health_check.py +++ b/koyeb/api/models/grpc_health_check.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/has_unpaid_invoices_reply.py b/koyeb/api/models/has_unpaid_invoices_reply.py index d474ea9e..0da1663d 100644 --- a/koyeb/api/models/has_unpaid_invoices_reply.py +++ b/koyeb/api/models/has_unpaid_invoices_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/http_header.py b/koyeb/api/models/http_header.py index b6525c46..4eed0257 100644 --- a/koyeb/api/models/http_header.py +++ b/koyeb/api/models/http_header.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/http_health_check.py b/koyeb/api/models/http_health_check.py index 7113ae81..ae11762d 100644 --- a/koyeb/api/models/http_health_check.py +++ b/koyeb/api/models/http_health_check.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/instance.py b/koyeb/api/models/instance.py index 54d65b51..f163fa3a 100644 --- a/koyeb/api/models/instance.py +++ b/koyeb/api/models/instance.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/instance_availability.py b/koyeb/api/models/instance_availability.py index 9798706a..8c84d133 100644 --- a/koyeb/api/models/instance_availability.py +++ b/koyeb/api/models/instance_availability.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/instance_event.py b/koyeb/api/models/instance_event.py index 0723d3e4..f74af4c8 100644 --- a/koyeb/api/models/instance_event.py +++ b/koyeb/api/models/instance_event.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/instance_list_item.py b/koyeb/api/models/instance_list_item.py index b39b150b..7a50c22d 100644 --- a/koyeb/api/models/instance_list_item.py +++ b/koyeb/api/models/instance_list_item.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/instance_snapshot.py b/koyeb/api/models/instance_snapshot.py index 7fb26613..b54e3f07 100644 --- a/koyeb/api/models/instance_snapshot.py +++ b/koyeb/api/models/instance_snapshot.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/instance_snapshot_event.py b/koyeb/api/models/instance_snapshot_event.py index 3973c87b..98dbdfe5 100644 --- a/koyeb/api/models/instance_snapshot_event.py +++ b/koyeb/api/models/instance_snapshot_event.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/instance_snapshot_quotas.py b/koyeb/api/models/instance_snapshot_quotas.py index 9345e32e..b5fa63f0 100644 --- a/koyeb/api/models/instance_snapshot_quotas.py +++ b/koyeb/api/models/instance_snapshot_quotas.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/instance_snapshot_status.py b/koyeb/api/models/instance_snapshot_status.py index 7bf4c276..a7b121e9 100644 --- a/koyeb/api/models/instance_snapshot_status.py +++ b/koyeb/api/models/instance_snapshot_status.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/instance_snapshot_type.py b/koyeb/api/models/instance_snapshot_type.py index ed2af447..e472ea5e 100644 --- a/koyeb/api/models/instance_snapshot_type.py +++ b/koyeb/api/models/instance_snapshot_type.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/instance_snapshot_type_usage.py b/koyeb/api/models/instance_snapshot_type_usage.py index 7196bed6..59624b09 100644 --- a/koyeb/api/models/instance_snapshot_type_usage.py +++ b/koyeb/api/models/instance_snapshot_type_usage.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/instance_status.py b/koyeb/api/models/instance_status.py index b55bc490..45c2b19b 100644 --- a/koyeb/api/models/instance_status.py +++ b/koyeb/api/models/instance_status.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/instance_type_usage.py b/koyeb/api/models/instance_type_usage.py index 7b6f923c..d5b0d30e 100644 --- a/koyeb/api/models/instance_type_usage.py +++ b/koyeb/api/models/instance_type_usage.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/instance_usage.py b/koyeb/api/models/instance_usage.py index b2e50393..91d66173 100644 --- a/koyeb/api/models/instance_usage.py +++ b/koyeb/api/models/instance_usage.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/instances_summary.py b/koyeb/api/models/instances_summary.py index 2fd3a99e..00723bd0 100644 --- a/koyeb/api/models/instances_summary.py +++ b/koyeb/api/models/instances_summary.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/invite_user_request.py b/koyeb/api/models/invite_user_request.py index b216f397..eb11a5c4 100644 --- a/koyeb/api/models/invite_user_request.py +++ b/koyeb/api/models/invite_user_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/kgitproxy_branch.py b/koyeb/api/models/kgitproxy_branch.py index bbbb5b6e..1ffcdb78 100644 --- a/koyeb/api/models/kgitproxy_branch.py +++ b/koyeb/api/models/kgitproxy_branch.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/kgitproxy_git_hub_repository.py b/koyeb/api/models/kgitproxy_git_hub_repository.py index 3b6a4603..8a79d712 100644 --- a/koyeb/api/models/kgitproxy_git_hub_repository.py +++ b/koyeb/api/models/kgitproxy_git_hub_repository.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/kgitproxy_github_installation_status.py b/koyeb/api/models/kgitproxy_github_installation_status.py index b2644fec..794c3ec1 100644 --- a/koyeb/api/models/kgitproxy_github_installation_status.py +++ b/koyeb/api/models/kgitproxy_github_installation_status.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/kgitproxy_indexing_status.py b/koyeb/api/models/kgitproxy_indexing_status.py index e10b3041..871478e0 100644 --- a/koyeb/api/models/kgitproxy_indexing_status.py +++ b/koyeb/api/models/kgitproxy_indexing_status.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/kgitproxy_list_branches_reply.py b/koyeb/api/models/kgitproxy_list_branches_reply.py index 24a62ba6..cccbff82 100644 --- a/koyeb/api/models/kgitproxy_list_branches_reply.py +++ b/koyeb/api/models/kgitproxy_list_branches_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/kgitproxy_list_repositories_reply.py b/koyeb/api/models/kgitproxy_list_repositories_reply.py index 2d875357..de267532 100644 --- a/koyeb/api/models/kgitproxy_list_repositories_reply.py +++ b/koyeb/api/models/kgitproxy_list_repositories_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/kgitproxy_repository.py b/koyeb/api/models/kgitproxy_repository.py index 53adfa27..c3a09d39 100644 --- a/koyeb/api/models/kgitproxy_repository.py +++ b/koyeb/api/models/kgitproxy_repository.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/kgitproxy_repository_provider.py b/koyeb/api/models/kgitproxy_repository_provider.py index 0f639dec..f9364e88 100644 --- a/koyeb/api/models/kgitproxy_repository_provider.py +++ b/koyeb/api/models/kgitproxy_repository_provider.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/kmeta_get_organization_workspace_quotas_reply.py b/koyeb/api/models/kmeta_get_organization_workspace_quotas_reply.py new file mode 100644 index 00000000..d046078d --- /dev/null +++ b/koyeb/api/models/kmeta_get_organization_workspace_quotas_reply.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from koyeb.api.models.quotas import Quotas +from typing import Optional, Set +from typing_extensions import Self +from pydantic_core import to_jsonable_python + + +class KmetaGetOrganizationWorkspaceQuotasReply(BaseModel): + """ + KmetaGetOrganizationWorkspaceQuotasReply + """ # noqa: E501 + + quotas: Optional[Quotas] = None + __properties: ClassVar[List[str]] = ["quotas"] + + model_config = ConfigDict( + validate_by_name=True, + validate_by_alias=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(to_jsonable_python(self.to_dict())) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of KmetaGetOrganizationWorkspaceQuotasReply from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of quotas + if self.quotas: + _dict["quotas"] = self.quotas.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of KmetaGetOrganizationWorkspaceQuotasReply from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "quotas": Quotas.from_dict(obj["quotas"]) + if obj.get("quotas") is not None + else None + } + ) + return _obj diff --git a/koyeb/api/models/ksearch_app.py b/koyeb/api/models/ksearch_app.py index 35177b2b..fdd8a208 100644 --- a/koyeb/api/models/ksearch_app.py +++ b/koyeb/api/models/ksearch_app.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/ksearch_global_deployment.py b/koyeb/api/models/ksearch_global_deployment.py index a073ba07..ca4372c8 100644 --- a/koyeb/api/models/ksearch_global_deployment.py +++ b/koyeb/api/models/ksearch_global_deployment.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/ksearch_instance.py b/koyeb/api/models/ksearch_instance.py index d7b0de96..c7525a6a 100644 --- a/koyeb/api/models/ksearch_instance.py +++ b/koyeb/api/models/ksearch_instance.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/ksearch_organization.py b/koyeb/api/models/ksearch_organization.py index c9e27c77..240ad0d0 100644 --- a/koyeb/api/models/ksearch_organization.py +++ b/koyeb/api/models/ksearch_organization.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/ksearch_regional_deployment.py b/koyeb/api/models/ksearch_regional_deployment.py index b18825e5..3429e7ed 100644 --- a/koyeb/api/models/ksearch_regional_deployment.py +++ b/koyeb/api/models/ksearch_regional_deployment.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/ksearch_search_reply.py b/koyeb/api/models/ksearch_search_reply.py index c6757562..d41e81bd 100644 --- a/koyeb/api/models/ksearch_search_reply.py +++ b/koyeb/api/models/ksearch_search_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/ksearch_service.py b/koyeb/api/models/ksearch_service.py index b7dfc5b8..28e4dabe 100644 --- a/koyeb/api/models/ksearch_service.py +++ b/koyeb/api/models/ksearch_service.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/ksearch_user.py b/koyeb/api/models/ksearch_user.py index cdff67c0..9734c413 100644 --- a/koyeb/api/models/ksearch_user.py +++ b/koyeb/api/models/ksearch_user.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/ktest_test_auth_reply.py b/koyeb/api/models/ktest_test_auth_reply.py index 7f6559d5..dd3ced88 100644 --- a/koyeb/api/models/ktest_test_auth_reply.py +++ b/koyeb/api/models/ktest_test_auth_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/ktest_test_auth_request.py b/koyeb/api/models/ktest_test_auth_request.py index 2900650b..fe6b6d99 100644 --- a/koyeb/api/models/ktest_test_auth_request.py +++ b/koyeb/api/models/ktest_test_auth_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/lifecycle_quotas.py b/koyeb/api/models/lifecycle_quotas.py index bc027411..2f1d1a0b 100644 --- a/koyeb/api/models/lifecycle_quotas.py +++ b/koyeb/api/models/lifecycle_quotas.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/list_app_events_reply.py b/koyeb/api/models/list_app_events_reply.py index 0d92a77d..7e6119b7 100644 --- a/koyeb/api/models/list_app_events_reply.py +++ b/koyeb/api/models/list_app_events_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/list_apps_reply.py b/koyeb/api/models/list_apps_reply.py index fb7797f4..ec2b6f6d 100644 --- a/koyeb/api/models/list_apps_reply.py +++ b/koyeb/api/models/list_apps_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/list_archives_reply.py b/koyeb/api/models/list_archives_reply.py new file mode 100644 index 00000000..2311268d --- /dev/null +++ b/koyeb/api/models/list_archives_reply.py @@ -0,0 +1,113 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictBool, StrictInt +from typing import Any, ClassVar, Dict, List, Optional +from koyeb.api.models.archive import Archive +from typing import Optional, Set +from typing_extensions import Self +from pydantic_core import to_jsonable_python + + +class ListArchivesReply(BaseModel): + """ + ListArchivesReply + """ # noqa: E501 + + archives: Optional[List[Archive]] = None + limit: Optional[StrictInt] = None + offset: Optional[StrictInt] = None + count: Optional[StrictInt] = None + has_next: Optional[StrictBool] = None + __properties: ClassVar[List[str]] = [ + "archives", + "limit", + "offset", + "count", + "has_next", + ] + + model_config = ConfigDict( + validate_by_name=True, + validate_by_alias=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(to_jsonable_python(self.to_dict())) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ListArchivesReply from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in archives (list) + _items = [] + if self.archives: + for _item_archives in self.archives: + _items.append( + _item_archives.to_dict() if _item_archives is not None else None + ) + _dict["archives"] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ListArchivesReply from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "archives": [Archive.from_dict(_item) for _item in obj["archives"]] + if obj.get("archives") is not None + else None, + "limit": obj.get("limit"), + "offset": obj.get("offset"), + "count": obj.get("count"), + "has_next": obj.get("has_next"), + } + ) + return _obj diff --git a/koyeb/api/models/list_catalog_instances_reply.py b/koyeb/api/models/list_catalog_instances_reply.py index 0510ddf8..9691a6e8 100644 --- a/koyeb/api/models/list_catalog_instances_reply.py +++ b/koyeb/api/models/list_catalog_instances_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/list_credentials_reply.py b/koyeb/api/models/list_credentials_reply.py index c9990b3c..99e0e0a9 100644 --- a/koyeb/api/models/list_credentials_reply.py +++ b/koyeb/api/models/list_credentials_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/list_datacenters_reply.py b/koyeb/api/models/list_datacenters_reply.py index 2b44690c..d4a9457e 100644 --- a/koyeb/api/models/list_datacenters_reply.py +++ b/koyeb/api/models/list_datacenters_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/list_deployment_events_reply.py b/koyeb/api/models/list_deployment_events_reply.py index 428121ac..d629b422 100644 --- a/koyeb/api/models/list_deployment_events_reply.py +++ b/koyeb/api/models/list_deployment_events_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/list_deployments_reply.py b/koyeb/api/models/list_deployments_reply.py index 44925340..3a5cb17e 100644 --- a/koyeb/api/models/list_deployments_reply.py +++ b/koyeb/api/models/list_deployments_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/list_domains_reply.py b/koyeb/api/models/list_domains_reply.py index cc0b3c2b..226bc47d 100644 --- a/koyeb/api/models/list_domains_reply.py +++ b/koyeb/api/models/list_domains_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/list_instance_events_reply.py b/koyeb/api/models/list_instance_events_reply.py index 35270bd8..39df9720 100644 --- a/koyeb/api/models/list_instance_events_reply.py +++ b/koyeb/api/models/list_instance_events_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/list_instance_snapshot_events_reply.py b/koyeb/api/models/list_instance_snapshot_events_reply.py index f883c548..9c6f2a38 100644 --- a/koyeb/api/models/list_instance_snapshot_events_reply.py +++ b/koyeb/api/models/list_instance_snapshot_events_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/list_instance_snapshots_reply.py b/koyeb/api/models/list_instance_snapshots_reply.py index 27b0cb72..e57559a7 100644 --- a/koyeb/api/models/list_instance_snapshots_reply.py +++ b/koyeb/api/models/list_instance_snapshots_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/list_instances_reply.py b/koyeb/api/models/list_instances_reply.py index 13f28809..25d2ce26 100644 --- a/koyeb/api/models/list_instances_reply.py +++ b/koyeb/api/models/list_instances_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/list_organization_invitations_reply.py b/koyeb/api/models/list_organization_invitations_reply.py index 39a0ff1d..ae5b355d 100644 --- a/koyeb/api/models/list_organization_invitations_reply.py +++ b/koyeb/api/models/list_organization_invitations_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/list_organization_members_reply.py b/koyeb/api/models/list_organization_members_reply.py index 24fe23d6..315bb1b9 100644 --- a/koyeb/api/models/list_organization_members_reply.py +++ b/koyeb/api/models/list_organization_members_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/list_payment_methods_reply.py b/koyeb/api/models/list_payment_methods_reply.py index 10a481da..b805e996 100644 --- a/koyeb/api/models/list_payment_methods_reply.py +++ b/koyeb/api/models/list_payment_methods_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/list_persistent_volume_events_reply.py b/koyeb/api/models/list_persistent_volume_events_reply.py index 96630bc5..fc2ceec1 100644 --- a/koyeb/api/models/list_persistent_volume_events_reply.py +++ b/koyeb/api/models/list_persistent_volume_events_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/list_persistent_volumes_reply.py b/koyeb/api/models/list_persistent_volumes_reply.py index 4d04b9e4..abe84bc7 100644 --- a/koyeb/api/models/list_persistent_volumes_reply.py +++ b/koyeb/api/models/list_persistent_volumes_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/list_pool_claim_reply.py b/koyeb/api/models/list_pool_claim_reply.py index c1300565..0af25eab 100644 --- a/koyeb/api/models/list_pool_claim_reply.py +++ b/koyeb/api/models/list_pool_claim_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/list_projects_reply.py b/koyeb/api/models/list_projects_reply.py index ddfdea1d..23a1ecae 100644 --- a/koyeb/api/models/list_projects_reply.py +++ b/koyeb/api/models/list_projects_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/list_regional_deployment_events_reply.py b/koyeb/api/models/list_regional_deployment_events_reply.py index 229ad3c4..815fe693 100644 --- a/koyeb/api/models/list_regional_deployment_events_reply.py +++ b/koyeb/api/models/list_regional_deployment_events_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/list_regional_deployments_reply.py b/koyeb/api/models/list_regional_deployments_reply.py index 4d06494c..e4c064d1 100644 --- a/koyeb/api/models/list_regional_deployments_reply.py +++ b/koyeb/api/models/list_regional_deployments_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/list_regions_reply.py b/koyeb/api/models/list_regions_reply.py index 9e8d10e3..07accedf 100644 --- a/koyeb/api/models/list_regions_reply.py +++ b/koyeb/api/models/list_regions_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/list_secrets_reply.py b/koyeb/api/models/list_secrets_reply.py index 8619117b..a3267ee7 100644 --- a/koyeb/api/models/list_secrets_reply.py +++ b/koyeb/api/models/list_secrets_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/list_service_events_reply.py b/koyeb/api/models/list_service_events_reply.py index d05109c5..b986b39e 100644 --- a/koyeb/api/models/list_service_events_reply.py +++ b/koyeb/api/models/list_service_events_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/list_service_pools_reply.py b/koyeb/api/models/list_service_pools_reply.py index ed02768c..df8f7a05 100644 --- a/koyeb/api/models/list_service_pools_reply.py +++ b/koyeb/api/models/list_service_pools_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/list_services_reply.py b/koyeb/api/models/list_services_reply.py index aada7461..8794a52e 100644 --- a/koyeb/api/models/list_services_reply.py +++ b/koyeb/api/models/list_services_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/list_snapshots_reply.py b/koyeb/api/models/list_snapshots_reply.py index f4e3b21b..39395f4c 100644 --- a/koyeb/api/models/list_snapshots_reply.py +++ b/koyeb/api/models/list_snapshots_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/list_usage_reply.py b/koyeb/api/models/list_usage_reply.py index bd193fce..d045f949 100644 --- a/koyeb/api/models/list_usage_reply.py +++ b/koyeb/api/models/list_usage_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/list_user_organization_invitations_reply.py b/koyeb/api/models/list_user_organization_invitations_reply.py index d2e023b8..42302d2b 100644 --- a/koyeb/api/models/list_user_organization_invitations_reply.py +++ b/koyeb/api/models/list_user_organization_invitations_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/list_user_organizations_reply.py b/koyeb/api/models/list_user_organizations_reply.py index bacbe414..21048fc8 100644 --- a/koyeb/api/models/list_user_organizations_reply.py +++ b/koyeb/api/models/list_user_organizations_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/log_entry.py b/koyeb/api/models/log_entry.py index 36b567ed..6162148f 100644 --- a/koyeb/api/models/log_entry.py +++ b/koyeb/api/models/log_entry.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/login_method_reply.py b/koyeb/api/models/login_method_reply.py index dc73e8d7..e8bc8881 100644 --- a/koyeb/api/models/login_method_reply.py +++ b/koyeb/api/models/login_method_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/login_method_reply_method.py b/koyeb/api/models/login_method_reply_method.py index c8eccaa8..c09a1bbe 100644 --- a/koyeb/api/models/login_method_reply_method.py +++ b/koyeb/api/models/login_method_reply_method.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/login_reply.py b/koyeb/api/models/login_reply.py index 91373487..ec97279f 100644 --- a/koyeb/api/models/login_reply.py +++ b/koyeb/api/models/login_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/login_request.py b/koyeb/api/models/login_request.py index e8631098..0e1884f7 100644 --- a/koyeb/api/models/login_request.py +++ b/koyeb/api/models/login_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/manage_reply.py b/koyeb/api/models/manage_reply.py index 8a63ecb1..9707e2ff 100644 --- a/koyeb/api/models/manage_reply.py +++ b/koyeb/api/models/manage_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/manual_service_scaling.py b/koyeb/api/models/manual_service_scaling.py index b66c1504..d0dbeb23 100644 --- a/koyeb/api/models/manual_service_scaling.py +++ b/koyeb/api/models/manual_service_scaling.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/members_summary.py b/koyeb/api/models/members_summary.py index 7f8a146e..b36f70d9 100644 --- a/koyeb/api/models/members_summary.py +++ b/koyeb/api/models/members_summary.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/mesh.py b/koyeb/api/models/mesh.py index de1227a8..3501483d 100644 --- a/koyeb/api/models/mesh.py +++ b/koyeb/api/models/mesh.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/mesh_scope.py b/koyeb/api/models/mesh_scope.py index 09c58074..ce5884bb 100644 --- a/koyeb/api/models/mesh_scope.py +++ b/koyeb/api/models/mesh_scope.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/metric_name.py b/koyeb/api/models/metric_name.py index 04fe8f9c..74be0500 100644 --- a/koyeb/api/models/metric_name.py +++ b/koyeb/api/models/metric_name.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/neon_postgres_database.py b/koyeb/api/models/neon_postgres_database.py index b503bcda..9a3ded25 100644 --- a/koyeb/api/models/neon_postgres_database.py +++ b/koyeb/api/models/neon_postgres_database.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/neon_postgres_database_deployment_metadata.py b/koyeb/api/models/neon_postgres_database_deployment_metadata.py index 8319b37b..0a5efb00 100644 --- a/koyeb/api/models/neon_postgres_database_deployment_metadata.py +++ b/koyeb/api/models/neon_postgres_database_deployment_metadata.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/neon_postgres_database_neon_database.py b/koyeb/api/models/neon_postgres_database_neon_database.py index 92ee9a8d..09b9f803 100644 --- a/koyeb/api/models/neon_postgres_database_neon_database.py +++ b/koyeb/api/models/neon_postgres_database_neon_database.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/neon_postgres_database_neon_role.py b/koyeb/api/models/neon_postgres_database_neon_role.py index 197ccfca..bed5f1b2 100644 --- a/koyeb/api/models/neon_postgres_database_neon_role.py +++ b/koyeb/api/models/neon_postgres_database_neon_role.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/neon_postgres_summary.py b/koyeb/api/models/neon_postgres_summary.py index 1498922b..345a047e 100644 --- a/koyeb/api/models/neon_postgres_summary.py +++ b/koyeb/api/models/neon_postgres_summary.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/network_policy.py b/koyeb/api/models/network_policy.py index 2fc6b036..a81b80e5 100644 --- a/koyeb/api/models/network_policy.py +++ b/koyeb/api/models/network_policy.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/network_policy_destination.py b/koyeb/api/models/network_policy_destination.py index 74819999..314ca13a 100644 --- a/koyeb/api/models/network_policy_destination.py +++ b/koyeb/api/models/network_policy_destination.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/next_invoice_reply.py b/koyeb/api/models/next_invoice_reply.py index 466f15a9..aa9da240 100644 --- a/koyeb/api/models/next_invoice_reply.py +++ b/koyeb/api/models/next_invoice_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/next_invoice_reply_discount.py b/koyeb/api/models/next_invoice_reply_discount.py index d1aac567..7f6de75a 100644 --- a/koyeb/api/models/next_invoice_reply_discount.py +++ b/koyeb/api/models/next_invoice_reply_discount.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/next_invoice_reply_discount_type.py b/koyeb/api/models/next_invoice_reply_discount_type.py index 1e4d17b9..ccddd6c0 100644 --- a/koyeb/api/models/next_invoice_reply_discount_type.py +++ b/koyeb/api/models/next_invoice_reply_discount_type.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/next_invoice_reply_line.py b/koyeb/api/models/next_invoice_reply_line.py index 794f7337..e0da62bd 100644 --- a/koyeb/api/models/next_invoice_reply_line.py +++ b/koyeb/api/models/next_invoice_reply_line.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/next_invoice_reply_line_period.py b/koyeb/api/models/next_invoice_reply_line_period.py index 2ab5705c..5cf6471b 100644 --- a/koyeb/api/models/next_invoice_reply_line_period.py +++ b/koyeb/api/models/next_invoice_reply_line_period.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/next_invoice_reply_line_price.py b/koyeb/api/models/next_invoice_reply_line_price.py index f63eab5a..dc47bd90 100644 --- a/koyeb/api/models/next_invoice_reply_line_price.py +++ b/koyeb/api/models/next_invoice_reply_line_price.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/notification.py b/koyeb/api/models/notification.py index 8b9e9d16..747bf49f 100644 --- a/koyeb/api/models/notification.py +++ b/koyeb/api/models/notification.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/notification_list.py b/koyeb/api/models/notification_list.py index 6979e5a9..be83f454 100644 --- a/koyeb/api/models/notification_list.py +++ b/koyeb/api/models/notification_list.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/o_auth_callback_reply.py b/koyeb/api/models/o_auth_callback_reply.py index 122c6f01..850c143c 100644 --- a/koyeb/api/models/o_auth_callback_reply.py +++ b/koyeb/api/models/o_auth_callback_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/o_auth_callback_request.py b/koyeb/api/models/o_auth_callback_request.py index 62512cc5..0cf319eb 100644 --- a/koyeb/api/models/o_auth_callback_request.py +++ b/koyeb/api/models/o_auth_callback_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/o_auth_provider.py b/koyeb/api/models/o_auth_provider.py index 62da2980..487e69f7 100644 --- a/koyeb/api/models/o_auth_provider.py +++ b/koyeb/api/models/o_auth_provider.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/object.py b/koyeb/api/models/object.py index ae4edf2a..42532267 100644 --- a/koyeb/api/models/object.py +++ b/koyeb/api/models/object.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/organization.py b/koyeb/api/models/organization.py index 584f1b1c..da405078 100644 --- a/koyeb/api/models/organization.py +++ b/koyeb/api/models/organization.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/organization_deactivation_reason.py b/koyeb/api/models/organization_deactivation_reason.py index be4ea25b..4a40d3b6 100644 --- a/koyeb/api/models/organization_deactivation_reason.py +++ b/koyeb/api/models/organization_deactivation_reason.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/organization_detailed_status.py b/koyeb/api/models/organization_detailed_status.py index 97152a5a..b289793d 100644 --- a/koyeb/api/models/organization_detailed_status.py +++ b/koyeb/api/models/organization_detailed_status.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/organization_invitation.py b/koyeb/api/models/organization_invitation.py index b9c4d5af..a125d9e4 100644 --- a/koyeb/api/models/organization_invitation.py +++ b/koyeb/api/models/organization_invitation.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/organization_invitation_status.py b/koyeb/api/models/organization_invitation_status.py index 79b188ac..455a5dc4 100644 --- a/koyeb/api/models/organization_invitation_status.py +++ b/koyeb/api/models/organization_invitation_status.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/organization_member.py b/koyeb/api/models/organization_member.py index 1257ac7f..2336bace 100644 --- a/koyeb/api/models/organization_member.py +++ b/koyeb/api/models/organization_member.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/organization_member_status.py b/koyeb/api/models/organization_member_status.py index a3c3dfcf..67fde6b7 100644 --- a/koyeb/api/models/organization_member_status.py +++ b/koyeb/api/models/organization_member_status.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/organization_status.py b/koyeb/api/models/organization_status.py index 7b71ec15..5a643ac7 100644 --- a/koyeb/api/models/organization_status.py +++ b/koyeb/api/models/organization_status.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/organization_summary.py b/koyeb/api/models/organization_summary.py index d237d808..0187f41e 100644 --- a/koyeb/api/models/organization_summary.py +++ b/koyeb/api/models/organization_summary.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/payment_method.py b/koyeb/api/models/payment_method.py index 37b752cb..57c7ea8d 100644 --- a/koyeb/api/models/payment_method.py +++ b/koyeb/api/models/payment_method.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/payment_method_status.py b/koyeb/api/models/payment_method_status.py index 23137302..e334a42d 100644 --- a/koyeb/api/models/payment_method_status.py +++ b/koyeb/api/models/payment_method_status.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/period_usage.py b/koyeb/api/models/period_usage.py index 9fe502df..627f6f73 100644 --- a/koyeb/api/models/period_usage.py +++ b/koyeb/api/models/period_usage.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/persistent_volume.py b/koyeb/api/models/persistent_volume.py index 82522e1c..544ccdb8 100644 --- a/koyeb/api/models/persistent_volume.py +++ b/koyeb/api/models/persistent_volume.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/persistent_volume_backing_store.py b/koyeb/api/models/persistent_volume_backing_store.py index b0b52db9..080ab099 100644 --- a/koyeb/api/models/persistent_volume_backing_store.py +++ b/koyeb/api/models/persistent_volume_backing_store.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/persistent_volume_event.py b/koyeb/api/models/persistent_volume_event.py index f04abe91..ca723db1 100644 --- a/koyeb/api/models/persistent_volume_event.py +++ b/koyeb/api/models/persistent_volume_event.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/persistent_volume_quotas.py b/koyeb/api/models/persistent_volume_quotas.py index d250f912..5838f1ca 100644 --- a/koyeb/api/models/persistent_volume_quotas.py +++ b/koyeb/api/models/persistent_volume_quotas.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/persistent_volume_region_usage.py b/koyeb/api/models/persistent_volume_region_usage.py index 11ec76f7..f5ced990 100644 --- a/koyeb/api/models/persistent_volume_region_usage.py +++ b/koyeb/api/models/persistent_volume_region_usage.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/persistent_volume_status.py b/koyeb/api/models/persistent_volume_status.py index 3ad575e0..3c2e44b7 100644 --- a/koyeb/api/models/persistent_volume_status.py +++ b/koyeb/api/models/persistent_volume_status.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/plan.py b/koyeb/api/models/plan.py index 08b1384e..afc5fdb9 100644 --- a/koyeb/api/models/plan.py +++ b/koyeb/api/models/plan.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/pool_claim.py b/koyeb/api/models/pool_claim.py index f1ff7511..3a5be53f 100644 --- a/koyeb/api/models/pool_claim.py +++ b/koyeb/api/models/pool_claim.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -38,10 +38,8 @@ class PoolClaim(BaseModel): status: Optional[PoolClaimStatus] = PoolClaimStatus.UNSPECIFIED organization_id: Optional[StrictStr] = None workspace_id: Optional[StrictStr] = None - customer_id: Optional[StrictStr] = None created_at: Optional[datetime] = None fulfilled_at: Optional[datetime] = None - released_at: Optional[datetime] = None pool_generation: Optional[StrictStr] = None __properties: ClassVar[List[str]] = [ "id", @@ -51,10 +49,8 @@ class PoolClaim(BaseModel): "status", "organization_id", "workspace_id", - "customer_id", "created_at", "fulfilled_at", - "released_at", "pool_generation", ] @@ -117,10 +113,8 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: else PoolClaimStatus.UNSPECIFIED, "organization_id": obj.get("organization_id"), "workspace_id": obj.get("workspace_id"), - "customer_id": obj.get("customer_id"), "created_at": obj.get("created_at"), "fulfilled_at": obj.get("fulfilled_at"), - "released_at": obj.get("released_at"), "pool_generation": obj.get("pool_generation"), } ) diff --git a/koyeb/api/models/pool_claim_reply.py b/koyeb/api/models/pool_claim_reply.py index 208ec011..5278f432 100644 --- a/koyeb/api/models/pool_claim_reply.py +++ b/koyeb/api/models/pool_claim_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/pool_claim_request.py b/koyeb/api/models/pool_claim_request.py index 9d2968cb..ad501e32 100644 --- a/koyeb/api/models/pool_claim_request.py +++ b/koyeb/api/models/pool_claim_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -17,7 +17,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List, Optional from typing import Optional, Set from typing_extensions import Self @@ -30,7 +30,10 @@ class PoolClaimRequest(BaseModel): """ # noqa: E501 pool_id: Optional[StrictStr] = None - request_id: Optional[StrictStr] = None + request_id: Optional[StrictStr] = Field( + default=None, + description="Idempotency key scoped to the pool: retries with the same value return the same claim. A fresh id is generated when omitted.", + ) __properties: ClassVar[List[str]] = ["pool_id", "request_id"] model_config = ConfigDict( diff --git a/koyeb/api/models/pool_claim_status.py b/koyeb/api/models/pool_claim_status.py index b05f69b1..1b6c07d9 100644 --- a/koyeb/api/models/pool_claim_status.py +++ b/koyeb/api/models/pool_claim_status.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -30,7 +30,6 @@ class PoolClaimStatus(str, Enum): PENDING = "PENDING" FULFILLED = "FULFILLED" FAILED = "FAILED" - RELEASED = "RELEASED" @classmethod def from_json(cls, json_str: str) -> Self: diff --git a/koyeb/api/models/port.py b/koyeb/api/models/port.py index 6c990f5a..a66edd1a 100644 --- a/koyeb/api/models/port.py +++ b/koyeb/api/models/port.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/private_registry_configuration.py b/koyeb/api/models/private_registry_configuration.py index 029aa86b..aafedac2 100644 --- a/koyeb/api/models/private_registry_configuration.py +++ b/koyeb/api/models/private_registry_configuration.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/project.py b/koyeb/api/models/project.py index 2b0db6f3..0f9f286a 100644 --- a/koyeb/api/models/project.py +++ b/koyeb/api/models/project.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/proxy_port_protocol.py b/koyeb/api/models/proxy_port_protocol.py index 886bb3bc..4666ec21 100644 --- a/koyeb/api/models/proxy_port_protocol.py +++ b/koyeb/api/models/proxy_port_protocol.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/public_organization.py b/koyeb/api/models/public_organization.py index 5629b08d..1dc9b804 100644 --- a/koyeb/api/models/public_organization.py +++ b/koyeb/api/models/public_organization.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/public_user.py b/koyeb/api/models/public_user.py index 7cc3859e..e473879a 100644 --- a/koyeb/api/models/public_user.py +++ b/koyeb/api/models/public_user.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/query_logs_reply.py b/koyeb/api/models/query_logs_reply.py index 2411e9e0..69c70159 100644 --- a/koyeb/api/models/query_logs_reply.py +++ b/koyeb/api/models/query_logs_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/query_logs_reply_pagination.py b/koyeb/api/models/query_logs_reply_pagination.py index 3c478605..aa0a330e 100644 --- a/koyeb/api/models/query_logs_reply_pagination.py +++ b/koyeb/api/models/query_logs_reply_pagination.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/query_services_view_filters.py b/koyeb/api/models/query_services_view_filters.py new file mode 100644 index 00000000..e71e7736 --- /dev/null +++ b/koyeb/api/models/query_services_view_filters.py @@ -0,0 +1,116 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from koyeb.api.models.service_status import ServiceStatus +from koyeb.api.models.service_type import ServiceType +from koyeb.api.models.service_view_active_deployment_state import ( + ServiceViewActiveDeploymentState, +) +from koyeb.api.models.service_view_latest_deployment_state import ( + ServiceViewLatestDeploymentState, +) +from typing import Optional, Set +from typing_extensions import Self +from pydantic_core import to_jsonable_python + + +class QueryServicesViewFilters(BaseModel): + """ + QueryServicesViewFilters + """ # noqa: E501 + + types: Optional[List[ServiceType]] = None + statuses: Optional[List[ServiceStatus]] = None + regions: Optional[List[StrictStr]] = None + app_ids: Optional[List[StrictStr]] = None + active_deployment_states: Optional[List[ServiceViewActiveDeploymentState]] = None + latest_deployment_states: Optional[List[ServiceViewLatestDeploymentState]] = None + needs_attention: Optional[StrictBool] = None + __properties: ClassVar[List[str]] = [ + "types", + "statuses", + "regions", + "app_ids", + "active_deployment_states", + "latest_deployment_states", + "needs_attention", + ] + + model_config = ConfigDict( + validate_by_name=True, + validate_by_alias=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(to_jsonable_python(self.to_dict())) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of QueryServicesViewFilters from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of QueryServicesViewFilters from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "types": obj.get("types"), + "statuses": obj.get("statuses"), + "regions": obj.get("regions"), + "app_ids": obj.get("app_ids"), + "active_deployment_states": obj.get("active_deployment_states"), + "latest_deployment_states": obj.get("latest_deployment_states"), + "needs_attention": obj.get("needs_attention"), + } + ) + return _obj diff --git a/koyeb/api/models/query_services_view_reply.py b/koyeb/api/models/query_services_view_reply.py new file mode 100644 index 00000000..26655109 --- /dev/null +++ b/koyeb/api/models/query_services_view_reply.py @@ -0,0 +1,143 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictBool, StrictInt +from typing import Any, ClassVar, Dict, List, Optional +from koyeb.api.models.service_view_facet import ServiceViewFacet +from koyeb.api.models.service_view_group import ServiceViewGroup +from koyeb.api.models.service_view_row import ServiceViewRow +from typing import Optional, Set +from typing_extensions import Self +from pydantic_core import to_jsonable_python + + +class QueryServicesViewReply(BaseModel): + """ + QueryServicesViewReply + """ # noqa: E501 + + services: Optional[List[ServiceViewRow]] = None + groups: Optional[List[ServiceViewGroup]] = None + facets: Optional[List[ServiceViewFacet]] = None + limit: Optional[StrictInt] = None + offset: Optional[StrictInt] = None + count: Optional[StrictInt] = None + has_next: Optional[StrictBool] = None + __properties: ClassVar[List[str]] = [ + "services", + "groups", + "facets", + "limit", + "offset", + "count", + "has_next", + ] + + model_config = ConfigDict( + validate_by_name=True, + validate_by_alias=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(to_jsonable_python(self.to_dict())) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of QueryServicesViewReply from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in services (list) + _items = [] + if self.services: + for _item_services in self.services: + _items.append( + _item_services.to_dict() if _item_services is not None else None + ) + _dict["services"] = _items + # override the default output from pydantic by calling `to_dict()` of each item in groups (list) + _items = [] + if self.groups: + for _item_groups in self.groups: + _items.append( + _item_groups.to_dict() if _item_groups is not None else None + ) + _dict["groups"] = _items + # override the default output from pydantic by calling `to_dict()` of each item in facets (list) + _items = [] + if self.facets: + for _item_facets in self.facets: + _items.append( + _item_facets.to_dict() if _item_facets is not None else None + ) + _dict["facets"] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of QueryServicesViewReply from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "services": [ + ServiceViewRow.from_dict(_item) for _item in obj["services"] + ] + if obj.get("services") is not None + else None, + "groups": [ServiceViewGroup.from_dict(_item) for _item in obj["groups"]] + if obj.get("groups") is not None + else None, + "facets": [ServiceViewFacet.from_dict(_item) for _item in obj["facets"]] + if obj.get("facets") is not None + else None, + "limit": obj.get("limit"), + "offset": obj.get("offset"), + "count": obj.get("count"), + "has_next": obj.get("has_next"), + } + ) + return _obj diff --git a/koyeb/api/models/query_services_view_sort.py b/koyeb/api/models/query_services_view_sort.py new file mode 100644 index 00000000..63234943 --- /dev/null +++ b/koyeb/api/models/query_services_view_sort.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from koyeb.api.models.query_services_view_sort_direction import ( + QueryServicesViewSortDirection, +) +from koyeb.api.models.query_services_view_sort_field import QueryServicesViewSortField +from typing import Optional, Set +from typing_extensions import Self +from pydantic_core import to_jsonable_python + + +class QueryServicesViewSort(BaseModel): + """ + QueryServicesViewSort + """ # noqa: E501 + + var_field: Optional[QueryServicesViewSortField] = Field( + default=QueryServicesViewSortField.CREATED_AT, alias="field" + ) + direction: Optional[ + QueryServicesViewSortDirection + ] = QueryServicesViewSortDirection.ASC + __properties: ClassVar[List[str]] = ["field", "direction"] + + model_config = ConfigDict( + validate_by_name=True, + validate_by_alias=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(to_jsonable_python(self.to_dict())) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of QueryServicesViewSort from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of QueryServicesViewSort from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "field": obj.get("field") + if obj.get("field") is not None + else QueryServicesViewSortField.CREATED_AT, + "direction": obj.get("direction") + if obj.get("direction") is not None + else QueryServicesViewSortDirection.ASC, + } + ) + return _obj diff --git a/koyeb/api/models/query_services_view_sort_direction.py b/koyeb/api/models/query_services_view_sort_direction.py new file mode 100644 index 00000000..c43eb9c5 --- /dev/null +++ b/koyeb/api/models/query_services_view_sort_direction.py @@ -0,0 +1,35 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class QueryServicesViewSortDirection(str, Enum): + """ + QueryServicesViewSortDirection + """ + + """ + allowed enum values + """ + ASC = "ASC" + DESC = "DESC" + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of QueryServicesViewSortDirection from a JSON string""" + return cls(json.loads(json_str)) diff --git a/koyeb/api/models/query_services_view_sort_field.py b/koyeb/api/models/query_services_view_sort_field.py new file mode 100644 index 00000000..d642b8f2 --- /dev/null +++ b/koyeb/api/models/query_services_view_sort_field.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class QueryServicesViewSortField(str, Enum): + """ + QueryServicesViewSortField + """ + + """ + allowed enum values + """ + CREATED_AT = "CREATED_AT" + UPDATED_AT = "UPDATED_AT" + NAME = "NAME" + APP_NAME = "APP_NAME" + ACTIVE_DEPLOYMENT_STATE = "ACTIVE_DEPLOYMENT_STATE" + LATEST_DEPLOYMENT_STATE = "LATEST_DEPLOYMENT_STATE" + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of QueryServicesViewSortField from a JSON string""" + return cls(json.loads(json_str)) diff --git a/koyeb/api/models/quota_usage.py b/koyeb/api/models/quota_usage.py index e285a0f9..48286df8 100644 --- a/koyeb/api/models/quota_usage.py +++ b/koyeb/api/models/quota_usage.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/quotas.py b/koyeb/api/models/quotas.py index a455d52f..d4b9ab19 100644 --- a/koyeb/api/models/quotas.py +++ b/koyeb/api/models/quotas.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -17,7 +17,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, StrictInt, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional from koyeb.api.models.domain_load_balancer_quotas import DomainLoadBalancerQuotas from koyeb.api.models.instance_snapshot_quotas import InstanceSnapshotQuotas @@ -56,6 +56,10 @@ class Quotas(BaseModel): lifecycle: Optional[LifecycleQuotas] = None max_projects: Optional[StrictStr] = None instance_snapshots: Optional[InstanceSnapshotQuotas] = None + persistent_volumes_disabled: Optional[StrictBool] = Field( + default=None, + description='When true, persistent volumes are disabled for the organization regardless of persistent_volumes_by_region. kaccount\'s ComputeQuotas omits persistent_volumes_by_region when this is set, so the flag must travel explicitly — otherwise consumers cannot distinguish "disabled" from "no custom quotas".', + ) __properties: ClassVar[List[str]] = [ "apps", "services", @@ -79,6 +83,7 @@ class Quotas(BaseModel): "lifecycle", "max_projects", "instance_snapshots", + "persistent_volumes_disabled", ] model_config = ConfigDict( @@ -199,6 +204,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: ) if obj.get("instance_snapshots") is not None else None, + "persistent_volumes_disabled": obj.get("persistent_volumes_disabled"), } ) return _obj diff --git a/koyeb/api/models/reactivate_organization_reply.py b/koyeb/api/models/reactivate_organization_reply.py index 3788e5d0..f7367930 100644 --- a/koyeb/api/models/reactivate_organization_reply.py +++ b/koyeb/api/models/reactivate_organization_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/redeem_coupon_request.py b/koyeb/api/models/redeem_coupon_request.py index 724890fd..f111b6e8 100644 --- a/koyeb/api/models/redeem_coupon_request.py +++ b/koyeb/api/models/redeem_coupon_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/redeploy_reply.py b/koyeb/api/models/redeploy_reply.py index c6329bdb..b36f22cb 100644 --- a/koyeb/api/models/redeploy_reply.py +++ b/koyeb/api/models/redeploy_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/redeploy_request_info.py b/koyeb/api/models/redeploy_request_info.py index 6889b0c3..f92c3eab 100644 --- a/koyeb/api/models/redeploy_request_info.py +++ b/koyeb/api/models/redeploy_request_info.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/region.py b/koyeb/api/models/region.py index da918102..4817edfa 100644 --- a/koyeb/api/models/region.py +++ b/koyeb/api/models/region.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/region_availability.py b/koyeb/api/models/region_availability.py index 2e379153..f493c7cb 100644 --- a/koyeb/api/models/region_availability.py +++ b/koyeb/api/models/region_availability.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/region_list_item.py b/koyeb/api/models/region_list_item.py index fc808a2f..5aad8ab9 100644 --- a/koyeb/api/models/region_list_item.py +++ b/koyeb/api/models/region_list_item.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/region_usage.py b/koyeb/api/models/region_usage.py index b7cc5efb..277eb7dd 100644 --- a/koyeb/api/models/region_usage.py +++ b/koyeb/api/models/region_usage.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/regional_deployment.py b/koyeb/api/models/regional_deployment.py index db898c3e..6063beba 100644 --- a/koyeb/api/models/regional_deployment.py +++ b/koyeb/api/models/regional_deployment.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/regional_deployment_definition.py b/koyeb/api/models/regional_deployment_definition.py index 04286afa..2a3d6470 100644 --- a/koyeb/api/models/regional_deployment_definition.py +++ b/koyeb/api/models/regional_deployment_definition.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -17,7 +17,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, StrictBool, StrictStr +from pydantic import BaseModel, ConfigDict, StrictBool, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional from koyeb.api.models.archive_source import ArchiveSource from koyeb.api.models.config_file import ConfigFile @@ -65,6 +65,7 @@ class RegionalDeploymentDefinition(BaseModel): RegionalDeploymentMesh ] = RegionalDeploymentMesh.REGIONAL_DEPLOYMENT_MESH_AUTO network_policy: Optional[NetworkPolicy] = None + kill_timeout_secs: Optional[StrictInt] = None docker: Optional[DockerSource] = None git: Optional[GitSource] = None archive: Optional[ArchiveSource] = None @@ -85,6 +86,7 @@ class RegionalDeploymentDefinition(BaseModel): "skip_cache", "mesh", "network_policy", + "kill_timeout_secs", "docker", "git", "archive", @@ -254,6 +256,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "network_policy": NetworkPolicy.from_dict(obj["network_policy"]) if obj.get("network_policy") is not None else None, + "kill_timeout_secs": obj.get("kill_timeout_secs"), "docker": DockerSource.from_dict(obj["docker"]) if obj.get("docker") is not None else None, diff --git a/koyeb/api/models/regional_deployment_definition_type.py b/koyeb/api/models/regional_deployment_definition_type.py index cf99a593..2b38fdb3 100644 --- a/koyeb/api/models/regional_deployment_definition_type.py +++ b/koyeb/api/models/regional_deployment_definition_type.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/regional_deployment_event.py b/koyeb/api/models/regional_deployment_event.py index 0d1c6dec..95c6f3bd 100644 --- a/koyeb/api/models/regional_deployment_event.py +++ b/koyeb/api/models/regional_deployment_event.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/regional_deployment_list_item.py b/koyeb/api/models/regional_deployment_list_item.py index 3d2a06be..dbaa7684 100644 --- a/koyeb/api/models/regional_deployment_list_item.py +++ b/koyeb/api/models/regional_deployment_list_item.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/regional_deployment_mesh.py b/koyeb/api/models/regional_deployment_mesh.py index 2a819434..1c49a0ed 100644 --- a/koyeb/api/models/regional_deployment_mesh.py +++ b/koyeb/api/models/regional_deployment_mesh.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/regional_deployment_metadata.py b/koyeb/api/models/regional_deployment_metadata.py index 77539027..4775a131 100644 --- a/koyeb/api/models/regional_deployment_metadata.py +++ b/koyeb/api/models/regional_deployment_metadata.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/regional_deployment_role.py b/koyeb/api/models/regional_deployment_role.py index 92908b22..b7352c77 100644 --- a/koyeb/api/models/regional_deployment_role.py +++ b/koyeb/api/models/regional_deployment_role.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/regional_deployment_status.py b/koyeb/api/models/regional_deployment_status.py index 7b21b754..11544241 100644 --- a/koyeb/api/models/regional_deployment_status.py +++ b/koyeb/api/models/regional_deployment_status.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/regional_deployment_volume.py b/koyeb/api/models/regional_deployment_volume.py index 0758da9e..3951cf1a 100644 --- a/koyeb/api/models/regional_deployment_volume.py +++ b/koyeb/api/models/regional_deployment_volume.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/remove_organization_member_reply.py b/koyeb/api/models/remove_organization_member_reply.py index b854135a..4731a243 100644 --- a/koyeb/api/models/remove_organization_member_reply.py +++ b/koyeb/api/models/remove_organization_member_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/resend_organization_invitation_reply.py b/koyeb/api/models/resend_organization_invitation_reply.py index 100cc6dc..84f5286f 100644 --- a/koyeb/api/models/resend_organization_invitation_reply.py +++ b/koyeb/api/models/resend_organization_invitation_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/reset_password_request.py b/koyeb/api/models/reset_password_request.py index 911dd4a1..97382cf9 100644 --- a/koyeb/api/models/reset_password_request.py +++ b/koyeb/api/models/reset_password_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/reveal_secret_reply.py b/koyeb/api/models/reveal_secret_reply.py index de3b4836..c95349f8 100644 --- a/koyeb/api/models/reveal_secret_reply.py +++ b/koyeb/api/models/reveal_secret_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/review_organization_capacity_reply.py b/koyeb/api/models/review_organization_capacity_reply.py index ffce029e..e21217e7 100644 --- a/koyeb/api/models/review_organization_capacity_reply.py +++ b/koyeb/api/models/review_organization_capacity_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/review_organization_capacity_request.py b/koyeb/api/models/review_organization_capacity_request.py index accb33be..91030bd3 100644 --- a/koyeb/api/models/review_organization_capacity_request.py +++ b/koyeb/api/models/review_organization_capacity_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/route.py b/koyeb/api/models/route.py index a502474f..6743a8db 100644 --- a/koyeb/api/models/route.py +++ b/koyeb/api/models/route.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/sample.py b/koyeb/api/models/sample.py index a462263c..2b4b8b02 100644 --- a/koyeb/api/models/sample.py +++ b/koyeb/api/models/sample.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/sandbox_metadata.py b/koyeb/api/models/sandbox_metadata.py index 3868167c..6b8d0d1a 100644 --- a/koyeb/api/models/sandbox_metadata.py +++ b/koyeb/api/models/sandbox_metadata.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -31,7 +31,8 @@ class SandboxMetadata(BaseModel): public_url: Optional[StrictStr] = None routing_key: Optional[StrictStr] = None - __properties: ClassVar[List[str]] = ["public_url", "routing_key"] + internal_url: Optional[StrictStr] = None + __properties: ClassVar[List[str]] = ["public_url", "routing_key", "internal_url"] model_config = ConfigDict( validate_by_name=True, @@ -82,6 +83,10 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: return cls.model_validate(obj) _obj = cls.model_validate( - {"public_url": obj.get("public_url"), "routing_key": obj.get("routing_key")} + { + "public_url": obj.get("public_url"), + "routing_key": obj.get("routing_key"), + "internal_url": obj.get("internal_url"), + } ) return _obj diff --git a/koyeb/api/models/scale_to_zero_quotas.py b/koyeb/api/models/scale_to_zero_quotas.py index afe4e3d7..2c48aa72 100644 --- a/koyeb/api/models/scale_to_zero_quotas.py +++ b/koyeb/api/models/scale_to_zero_quotas.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/scaling.py b/koyeb/api/models/scaling.py index db6f1349..f8c52c28 100644 --- a/koyeb/api/models/scaling.py +++ b/koyeb/api/models/scaling.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/secret.py b/koyeb/api/models/secret.py index e43733b5..bb30b4d6 100644 --- a/koyeb/api/models/secret.py +++ b/koyeb/api/models/secret.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/secret_type.py b/koyeb/api/models/secret_type.py index d58e874a..43528ab0 100644 --- a/koyeb/api/models/secret_type.py +++ b/koyeb/api/models/secret_type.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/secrets_summary.py b/koyeb/api/models/secrets_summary.py index c9ebbe40..5d435c62 100644 --- a/koyeb/api/models/secrets_summary.py +++ b/koyeb/api/models/secrets_summary.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/security_policies.py b/koyeb/api/models/security_policies.py index f4cec590..3280d400 100644 --- a/koyeb/api/models/security_policies.py +++ b/koyeb/api/models/security_policies.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/service.py b/koyeb/api/models/service.py index efa6839c..fe9d2e64 100644 --- a/koyeb/api/models/service.py +++ b/koyeb/api/models/service.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/service_event.py b/koyeb/api/models/service_event.py index 5146ee01..0c07ad87 100644 --- a/koyeb/api/models/service_event.py +++ b/koyeb/api/models/service_event.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/service_life_cycle.py b/koyeb/api/models/service_life_cycle.py index bcec37e4..b5017cfc 100644 --- a/koyeb/api/models/service_life_cycle.py +++ b/koyeb/api/models/service_life_cycle.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/service_list_item.py b/koyeb/api/models/service_list_item.py index ac201af1..5572f610 100644 --- a/koyeb/api/models/service_list_item.py +++ b/koyeb/api/models/service_list_item.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/service_pool.py b/koyeb/api/models/service_pool.py index 507b1896..7924bb7e 100644 --- a/koyeb/api/models/service_pool.py +++ b/koyeb/api/models/service_pool.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -44,7 +44,6 @@ class ServicePool(BaseModel): status: Optional[ServicePoolStatus] = ServicePoolStatus.UNSPECIFIED messages: Optional[List[StrictStr]] = None generation: Optional[StrictStr] = None - customer_id: Optional[StrictStr] = None __properties: ClassVar[List[str]] = [ "id", "created_at", @@ -58,7 +57,6 @@ class ServicePool(BaseModel): "status", "messages", "generation", - "customer_id", ] model_config = ConfigDict( @@ -130,7 +128,6 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: else ServicePoolStatus.UNSPECIFIED, "messages": obj.get("messages"), "generation": obj.get("generation"), - "customer_id": obj.get("customer_id"), } ) return _obj diff --git a/koyeb/api/models/service_pool_status.py b/koyeb/api/models/service_pool_status.py index fd5a03dc..1e5101c9 100644 --- a/koyeb/api/models/service_pool_status.py +++ b/koyeb/api/models/service_pool_status.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/service_state.py b/koyeb/api/models/service_state.py index 26f09e59..962709bd 100644 --- a/koyeb/api/models/service_state.py +++ b/koyeb/api/models/service_state.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/service_status.py b/koyeb/api/models/service_status.py index 2fde4c67..1bcc18d8 100644 --- a/koyeb/api/models/service_status.py +++ b/koyeb/api/models/service_status.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/service_summary.py b/koyeb/api/models/service_summary.py index 8c661d03..9e1cb66f 100644 --- a/koyeb/api/models/service_summary.py +++ b/koyeb/api/models/service_summary.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/service_type.py b/koyeb/api/models/service_type.py index 7f839c5b..2679dd3f 100644 --- a/koyeb/api/models/service_type.py +++ b/koyeb/api/models/service_type.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/service_usage.py b/koyeb/api/models/service_usage.py index 5f7ebb1b..c3a42a5f 100644 --- a/koyeb/api/models/service_usage.py +++ b/koyeb/api/models/service_usage.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/service_view_active_deployment.py b/koyeb/api/models/service_view_active_deployment.py new file mode 100644 index 00000000..d4478c7b --- /dev/null +++ b/koyeb/api/models/service_view_active_deployment.py @@ -0,0 +1,116 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from koyeb.api.models.deployment_status import DeploymentStatus +from koyeb.api.models.service_view_active_deployment_state import ( + ServiceViewActiveDeploymentState, +) +from typing import Optional, Set +from typing_extensions import Self +from pydantic_core import to_jsonable_python + + +class ServiceViewActiveDeployment(BaseModel): + """ + ServiceViewActiveDeployment + """ # noqa: E501 + + state: Optional[ + ServiceViewActiveDeploymentState + ] = ServiceViewActiveDeploymentState.NONE + id: Optional[StrictStr] = None + missing: Optional[StrictBool] = None + status: Optional[DeploymentStatus] = DeploymentStatus.PENDING + created_at: Optional[datetime] = None + updated_at: Optional[datetime] = None + __properties: ClassVar[List[str]] = [ + "state", + "id", + "missing", + "status", + "created_at", + "updated_at", + ] + + model_config = ConfigDict( + validate_by_name=True, + validate_by_alias=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(to_jsonable_python(self.to_dict())) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServiceViewActiveDeployment from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServiceViewActiveDeployment from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "state": obj.get("state") + if obj.get("state") is not None + else ServiceViewActiveDeploymentState.NONE, + "id": obj.get("id"), + "missing": obj.get("missing"), + "status": obj.get("status") + if obj.get("status") is not None + else DeploymentStatus.PENDING, + "created_at": obj.get("created_at"), + "updated_at": obj.get("updated_at"), + } + ) + return _obj diff --git a/koyeb/api/models/service_view_active_deployment_state.py b/koyeb/api/models/service_view_active_deployment_state.py new file mode 100644 index 00000000..40aa5161 --- /dev/null +++ b/koyeb/api/models/service_view_active_deployment_state.py @@ -0,0 +1,41 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class ServiceViewActiveDeploymentState(str, Enum): + """ + - SLEEPING: The active Deployment is scaled to zero and wakes up on traffic + """ + + """ + allowed enum values + """ + NONE = "NONE" + STARTING = "STARTING" + HEALTHY = "HEALTHY" + DEGRADED = "DEGRADED" + UNHEALTHY = "UNHEALTHY" + STOPPING = "STOPPING" + PAUSED = "PAUSED" + SLEEPING = "SLEEPING" + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of ServiceViewActiveDeploymentState from a JSON string""" + return cls(json.loads(json_str)) diff --git a/koyeb/api/models/service_view_app.py b/koyeb/api/models/service_view_app.py new file mode 100644 index 00000000..c6b5ab47 --- /dev/null +++ b/koyeb/api/models/service_view_app.py @@ -0,0 +1,85 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self +from pydantic_core import to_jsonable_python + + +class ServiceViewApp(BaseModel): + """ + ServiceViewApp + """ # noqa: E501 + + id: Optional[StrictStr] = None + name: Optional[StrictStr] = None + __properties: ClassVar[List[str]] = ["id", "name"] + + model_config = ConfigDict( + validate_by_name=True, + validate_by_alias=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(to_jsonable_python(self.to_dict())) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServiceViewApp from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServiceViewApp from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({"id": obj.get("id"), "name": obj.get("name")}) + return _obj diff --git a/koyeb/api/models/service_view_facet.py b/koyeb/api/models/service_view_facet.py new file mode 100644 index 00000000..f7f75793 --- /dev/null +++ b/koyeb/api/models/service_view_facet.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from koyeb.api.models.service_view_facet_kind import ServiceViewFacetKind +from koyeb.api.models.service_view_facet_value import ServiceViewFacetValue +from typing import Optional, Set +from typing_extensions import Self +from pydantic_core import to_jsonable_python + + +class ServiceViewFacet(BaseModel): + """ + ServiceViewFacet + """ # noqa: E501 + + kind: Optional[ServiceViewFacetKind] = ServiceViewFacetKind.TYPE + values: Optional[List[ServiceViewFacetValue]] = None + __properties: ClassVar[List[str]] = ["kind", "values"] + + model_config = ConfigDict( + validate_by_name=True, + validate_by_alias=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(to_jsonable_python(self.to_dict())) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServiceViewFacet from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in values (list) + _items = [] + if self.values: + for _item_values in self.values: + _items.append( + _item_values.to_dict() if _item_values is not None else None + ) + _dict["values"] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServiceViewFacet from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "kind": obj.get("kind") + if obj.get("kind") is not None + else ServiceViewFacetKind.TYPE, + "values": [ + ServiceViewFacetValue.from_dict(_item) for _item in obj["values"] + ] + if obj.get("values") is not None + else None, + } + ) + return _obj diff --git a/koyeb/api/models/service_view_facet_kind.py b/koyeb/api/models/service_view_facet_kind.py new file mode 100644 index 00000000..23ee22d4 --- /dev/null +++ b/koyeb/api/models/service_view_facet_kind.py @@ -0,0 +1,40 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class ServiceViewFacetKind(str, Enum): + """ + ServiceViewFacetKind + """ + + """ + allowed enum values + """ + TYPE = "TYPE" + STATUS = "STATUS" + REGION = "REGION" + APP = "APP" + ACTIVE_DEPLOYMENT_STATE = "ACTIVE_DEPLOYMENT_STATE" + LATEST_DEPLOYMENT_STATE = "LATEST_DEPLOYMENT_STATE" + NEEDS_ATTENTION = "NEEDS_ATTENTION" + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of ServiceViewFacetKind from a JSON string""" + return cls(json.loads(json_str)) diff --git a/koyeb/api/models/service_view_facet_value.py b/koyeb/api/models/service_view_facet_value.py new file mode 100644 index 00000000..60e13797 --- /dev/null +++ b/koyeb/api/models/service_view_facet_value.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self +from pydantic_core import to_jsonable_python + + +class ServiceViewFacetValue(BaseModel): + """ + ServiceViewFacetValue + """ # noqa: E501 + + value: Optional[StrictStr] = None + label: Optional[StrictStr] = None + count: Optional[StrictInt] = None + __properties: ClassVar[List[str]] = ["value", "label", "count"] + + model_config = ConfigDict( + validate_by_name=True, + validate_by_alias=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(to_jsonable_python(self.to_dict())) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServiceViewFacetValue from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServiceViewFacetValue from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "value": obj.get("value"), + "label": obj.get("label"), + "count": obj.get("count"), + } + ) + return _obj diff --git a/koyeb/api/models/service_view_group.py b/koyeb/api/models/service_view_group.py new file mode 100644 index 00000000..740594bf --- /dev/null +++ b/koyeb/api/models/service_view_group.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from koyeb.api.models.service_view_group_by import ServiceViewGroupBy +from typing import Optional, Set +from typing_extensions import Self +from pydantic_core import to_jsonable_python + + +class ServiceViewGroup(BaseModel): + """ + ServiceViewGroup + """ # noqa: E501 + + by: Optional[ServiceViewGroupBy] = ServiceViewGroupBy.NO_GROUP + key: Optional[StrictStr] = None + label: Optional[StrictStr] = None + count: Optional[StrictInt] = None + __properties: ClassVar[List[str]] = ["by", "key", "label", "count"] + + model_config = ConfigDict( + validate_by_name=True, + validate_by_alias=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(to_jsonable_python(self.to_dict())) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServiceViewGroup from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServiceViewGroup from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "by": obj.get("by") + if obj.get("by") is not None + else ServiceViewGroupBy.NO_GROUP, + "key": obj.get("key"), + "label": obj.get("label"), + "count": obj.get("count"), + } + ) + return _obj diff --git a/koyeb/api/models/service_view_group_by.py b/koyeb/api/models/service_view_group_by.py new file mode 100644 index 00000000..bf2ebf31 --- /dev/null +++ b/koyeb/api/models/service_view_group_by.py @@ -0,0 +1,35 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class ServiceViewGroupBy(str, Enum): + """ + ServiceViewGroupBy + """ + + """ + allowed enum values + """ + NO_GROUP = "NO_GROUP" + APP = "APP" + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of ServiceViewGroupBy from a JSON string""" + return cls(json.loads(json_str)) diff --git a/koyeb/api/models/service_view_latest_deployment.py b/koyeb/api/models/service_view_latest_deployment.py new file mode 100644 index 00000000..d0b45bbb --- /dev/null +++ b/koyeb/api/models/service_view_latest_deployment.py @@ -0,0 +1,116 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from koyeb.api.models.deployment_status import DeploymentStatus +from koyeb.api.models.service_view_latest_deployment_state import ( + ServiceViewLatestDeploymentState, +) +from typing import Optional, Set +from typing_extensions import Self +from pydantic_core import to_jsonable_python + + +class ServiceViewLatestDeployment(BaseModel): + """ + ServiceViewLatestDeployment + """ # noqa: E501 + + state: Optional[ + ServiceViewLatestDeploymentState + ] = ServiceViewLatestDeploymentState.NONE + id: Optional[StrictStr] = None + missing: Optional[StrictBool] = None + status: Optional[DeploymentStatus] = DeploymentStatus.PENDING + created_at: Optional[datetime] = None + updated_at: Optional[datetime] = None + __properties: ClassVar[List[str]] = [ + "state", + "id", + "missing", + "status", + "created_at", + "updated_at", + ] + + model_config = ConfigDict( + validate_by_name=True, + validate_by_alias=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(to_jsonable_python(self.to_dict())) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServiceViewLatestDeployment from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServiceViewLatestDeployment from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "state": obj.get("state") + if obj.get("state") is not None + else ServiceViewLatestDeploymentState.NONE, + "id": obj.get("id"), + "missing": obj.get("missing"), + "status": obj.get("status") + if obj.get("status") is not None + else DeploymentStatus.PENDING, + "created_at": obj.get("created_at"), + "updated_at": obj.get("updated_at"), + } + ) + return _obj diff --git a/koyeb/api/models/service_view_latest_deployment_state.py b/koyeb/api/models/service_view_latest_deployment_state.py new file mode 100644 index 00000000..b8af5a35 --- /dev/null +++ b/koyeb/api/models/service_view_latest_deployment_state.py @@ -0,0 +1,37 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class ServiceViewLatestDeploymentState(str, Enum): + """ + ServiceViewLatestDeploymentState + """ + + """ + allowed enum values + """ + NONE = "NONE" + STARTING = "STARTING" + STOPPING = "STOPPING" + FAILED = "FAILED" + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of ServiceViewLatestDeploymentState from a JSON string""" + return cls(json.loads(json_str)) diff --git a/koyeb/api/models/service_view_row.py b/koyeb/api/models/service_view_row.py new file mode 100644 index 00000000..5f9b98a6 --- /dev/null +++ b/koyeb/api/models/service_view_row.py @@ -0,0 +1,167 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from koyeb.api.models.service_status import ServiceStatus +from koyeb.api.models.service_type import ServiceType +from koyeb.api.models.service_view_active_deployment import ServiceViewActiveDeployment +from koyeb.api.models.service_view_app import ServiceViewApp +from koyeb.api.models.service_view_latest_deployment import ServiceViewLatestDeployment +from koyeb.api.models.service_view_source import ServiceViewSource +from typing import Optional, Set +from typing_extensions import Self +from pydantic_core import to_jsonable_python + + +class ServiceViewRow(BaseModel): + """ + ServiceViewRow + """ # noqa: E501 + + id: Optional[StrictStr] = None + name: Optional[StrictStr] = None + type: Optional[ServiceType] = ServiceType.INVALID_TYPE + status: Optional[ServiceStatus] = ServiceStatus.STARTING + messages: Optional[List[StrictStr]] = None + created_at: Optional[datetime] = None + updated_at: Optional[datetime] = None + app_id: Optional[StrictStr] = None + app: Optional[ServiceViewApp] = None + active_deployment: Optional[ServiceViewActiveDeployment] = None + latest_deployment: Optional[ServiceViewLatestDeployment] = None + needs_attention: Optional[StrictBool] = None + regions: Optional[List[StrictStr]] = None + instance_type: Optional[StrictStr] = None + source: Optional[ServiceViewSource] = None + __properties: ClassVar[List[str]] = [ + "id", + "name", + "type", + "status", + "messages", + "created_at", + "updated_at", + "app_id", + "app", + "active_deployment", + "latest_deployment", + "needs_attention", + "regions", + "instance_type", + "source", + ] + + model_config = ConfigDict( + validate_by_name=True, + validate_by_alias=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(to_jsonable_python(self.to_dict())) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServiceViewRow from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of app + if self.app: + _dict["app"] = self.app.to_dict() + # override the default output from pydantic by calling `to_dict()` of active_deployment + if self.active_deployment: + _dict["active_deployment"] = self.active_deployment.to_dict() + # override the default output from pydantic by calling `to_dict()` of latest_deployment + if self.latest_deployment: + _dict["latest_deployment"] = self.latest_deployment.to_dict() + # override the default output from pydantic by calling `to_dict()` of source + if self.source: + _dict["source"] = self.source.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServiceViewRow from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "id": obj.get("id"), + "name": obj.get("name"), + "type": obj.get("type") + if obj.get("type") is not None + else ServiceType.INVALID_TYPE, + "status": obj.get("status") + if obj.get("status") is not None + else ServiceStatus.STARTING, + "messages": obj.get("messages"), + "created_at": obj.get("created_at"), + "updated_at": obj.get("updated_at"), + "app_id": obj.get("app_id"), + "app": ServiceViewApp.from_dict(obj["app"]) + if obj.get("app") is not None + else None, + "active_deployment": ServiceViewActiveDeployment.from_dict( + obj["active_deployment"] + ) + if obj.get("active_deployment") is not None + else None, + "latest_deployment": ServiceViewLatestDeployment.from_dict( + obj["latest_deployment"] + ) + if obj.get("latest_deployment") is not None + else None, + "needs_attention": obj.get("needs_attention"), + "regions": obj.get("regions"), + "instance_type": obj.get("instance_type"), + "source": ServiceViewSource.from_dict(obj["source"]) + if obj.get("source") is not None + else None, + } + ) + return _obj diff --git a/koyeb/api/models/service_view_source.py b/koyeb/api/models/service_view_source.py new file mode 100644 index 00000000..067655dd --- /dev/null +++ b/koyeb/api/models/service_view_source.py @@ -0,0 +1,93 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from koyeb.api.models.service_view_source_type import ServiceViewSourceType +from typing import Optional, Set +from typing_extensions import Self +from pydantic_core import to_jsonable_python + + +class ServiceViewSource(BaseModel): + """ + ServiceViewSource + """ # noqa: E501 + + type: Optional[ServiceViewSourceType] = ServiceViewSourceType.UNKNOWN + reference: Optional[StrictStr] = None + __properties: ClassVar[List[str]] = ["type", "reference"] + + model_config = ConfigDict( + validate_by_name=True, + validate_by_alias=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(to_jsonable_python(self.to_dict())) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServiceViewSource from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServiceViewSource from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "type": obj.get("type") + if obj.get("type") is not None + else ServiceViewSourceType.UNKNOWN, + "reference": obj.get("reference"), + } + ) + return _obj diff --git a/koyeb/api/models/service_view_source_type.py b/koyeb/api/models/service_view_source_type.py new file mode 100644 index 00000000..889f6e5a --- /dev/null +++ b/koyeb/api/models/service_view_source_type.py @@ -0,0 +1,38 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class ServiceViewSourceType(str, Enum): + """ + ServiceViewSourceType + """ + + """ + allowed enum values + """ + UNKNOWN = "UNKNOWN" + DOCKER = "DOCKER" + GIT = "GIT" + ARCHIVE = "ARCHIVE" + DATABASE = "DATABASE" + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of ServiceViewSourceType from a JSON string""" + return cls(json.loads(json_str)) diff --git a/koyeb/api/models/snapshot.py b/koyeb/api/models/snapshot.py index c9d83312..a84b279c 100644 --- a/koyeb/api/models/snapshot.py +++ b/koyeb/api/models/snapshot.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/snapshot_status.py b/koyeb/api/models/snapshot_status.py index 014feb59..d896d889 100644 --- a/koyeb/api/models/snapshot_status.py +++ b/koyeb/api/models/snapshot_status.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -32,6 +32,7 @@ class SnapshotStatus(str, Enum): SNAPSHOT_STATUS_MIGRATING = "SNAPSHOT_STATUS_MIGRATING" SNAPSHOT_STATUS_DELETING = "SNAPSHOT_STATUS_DELETING" SNAPSHOT_STATUS_DELETED = "SNAPSHOT_STATUS_DELETED" + SNAPSHOT_STATUS_ERROR = "SNAPSHOT_STATUS_ERROR" @classmethod def from_json(cls, json_str: str) -> Self: diff --git a/koyeb/api/models/snapshot_type.py b/koyeb/api/models/snapshot_type.py index ff34880b..54eafd24 100644 --- a/koyeb/api/models/snapshot_type.py +++ b/koyeb/api/models/snapshot_type.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/stream_result_of_exec_command_reply.py b/koyeb/api/models/stream_result_of_exec_command_reply.py index 2bebe9cb..7f382ca8 100644 --- a/koyeb/api/models/stream_result_of_exec_command_reply.py +++ b/koyeb/api/models/stream_result_of_exec_command_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/stream_result_of_log_entry.py b/koyeb/api/models/stream_result_of_log_entry.py index ea5076ae..b041ae46 100644 --- a/koyeb/api/models/stream_result_of_log_entry.py +++ b/koyeb/api/models/stream_result_of_log_entry.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/subscription.py b/koyeb/api/models/subscription.py index a41ffe87..7fb763c9 100644 --- a/koyeb/api/models/subscription.py +++ b/koyeb/api/models/subscription.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/subscription_payment_failure.py b/koyeb/api/models/subscription_payment_failure.py index 66189e22..7f701a99 100644 --- a/koyeb/api/models/subscription_payment_failure.py +++ b/koyeb/api/models/subscription_payment_failure.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/subscription_payment_failure_stripe_sdk.py b/koyeb/api/models/subscription_payment_failure_stripe_sdk.py index 3e97164c..c223a54a 100644 --- a/koyeb/api/models/subscription_payment_failure_stripe_sdk.py +++ b/koyeb/api/models/subscription_payment_failure_stripe_sdk.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/subscription_status.py b/koyeb/api/models/subscription_status.py index 9ca68e76..2a22f4ab 100644 --- a/koyeb/api/models/subscription_status.py +++ b/koyeb/api/models/subscription_status.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/tcp_health_check.py b/koyeb/api/models/tcp_health_check.py index a2938aed..4f87e20b 100644 --- a/koyeb/api/models/tcp_health_check.py +++ b/koyeb/api/models/tcp_health_check.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/token.py b/koyeb/api/models/token.py index bc4f8c88..f4c64d83 100644 --- a/koyeb/api/models/token.py +++ b/koyeb/api/models/token.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/trigger_deployment_metadata.py b/koyeb/api/models/trigger_deployment_metadata.py index 8855f265..a55a3f48 100644 --- a/koyeb/api/models/trigger_deployment_metadata.py +++ b/koyeb/api/models/trigger_deployment_metadata.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/trigger_deployment_metadata_actor_type.py b/koyeb/api/models/trigger_deployment_metadata_actor_type.py index 13d05047..e975670d 100644 --- a/koyeb/api/models/trigger_deployment_metadata_actor_type.py +++ b/koyeb/api/models/trigger_deployment_metadata_actor_type.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/trigger_deployment_metadata_trigger_type.py b/koyeb/api/models/trigger_deployment_metadata_trigger_type.py index 71bfb900..8ca06dd2 100644 --- a/koyeb/api/models/trigger_deployment_metadata_trigger_type.py +++ b/koyeb/api/models/trigger_deployment_metadata_trigger_type.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/trigger_git_deployment_metadata.py b/koyeb/api/models/trigger_git_deployment_metadata.py index 46b3f2e0..7a7f9820 100644 --- a/koyeb/api/models/trigger_git_deployment_metadata.py +++ b/koyeb/api/models/trigger_git_deployment_metadata.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/trigger_git_deployment_metadata_provider.py b/koyeb/api/models/trigger_git_deployment_metadata_provider.py index 41c0f8de..ca50bb5c 100644 --- a/koyeb/api/models/trigger_git_deployment_metadata_provider.py +++ b/koyeb/api/models/trigger_git_deployment_metadata_provider.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/update_app.py b/koyeb/api/models/update_app.py index 14d24477..84ca2f86 100644 --- a/koyeb/api/models/update_app.py +++ b/koyeb/api/models/update_app.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/update_app_reply.py b/koyeb/api/models/update_app_reply.py index 9069e794..a5aaca4f 100644 --- a/koyeb/api/models/update_app_reply.py +++ b/koyeb/api/models/update_app_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/update_budget_reply.py b/koyeb/api/models/update_budget_reply.py index 1df4d92e..40f0a23f 100644 --- a/koyeb/api/models/update_budget_reply.py +++ b/koyeb/api/models/update_budget_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/update_budget_request.py b/koyeb/api/models/update_budget_request.py index 03739342..5c880fcc 100644 --- a/koyeb/api/models/update_budget_request.py +++ b/koyeb/api/models/update_budget_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/update_credential_reply.py b/koyeb/api/models/update_credential_reply.py index 4a4e4d1e..0708b7de 100644 --- a/koyeb/api/models/update_credential_reply.py +++ b/koyeb/api/models/update_credential_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/update_domain.py b/koyeb/api/models/update_domain.py index ab77593a..daefc9e8 100644 --- a/koyeb/api/models/update_domain.py +++ b/koyeb/api/models/update_domain.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/update_domain_reply.py b/koyeb/api/models/update_domain_reply.py index 680d7fdb..4ae440b1 100644 --- a/koyeb/api/models/update_domain_reply.py +++ b/koyeb/api/models/update_domain_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/update_organization_default_project_reply.py b/koyeb/api/models/update_organization_default_project_reply.py index fcce2520..1e3f9407 100644 --- a/koyeb/api/models/update_organization_default_project_reply.py +++ b/koyeb/api/models/update_organization_default_project_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/update_organization_default_project_request.py b/koyeb/api/models/update_organization_default_project_request.py index 6a94af83..24a0b156 100644 --- a/koyeb/api/models/update_organization_default_project_request.py +++ b/koyeb/api/models/update_organization_default_project_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/update_organization_name_reply.py b/koyeb/api/models/update_organization_name_reply.py index 6b1c4855..36760c82 100644 --- a/koyeb/api/models/update_organization_name_reply.py +++ b/koyeb/api/models/update_organization_name_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/update_organization_name_request.py b/koyeb/api/models/update_organization_name_request.py index 93f1f05e..5531f13b 100644 --- a/koyeb/api/models/update_organization_name_request.py +++ b/koyeb/api/models/update_organization_name_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/update_organization_plan_reply.py b/koyeb/api/models/update_organization_plan_reply.py index 1a1c7c20..396f372b 100644 --- a/koyeb/api/models/update_organization_plan_reply.py +++ b/koyeb/api/models/update_organization_plan_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/update_organization_plan_request.py b/koyeb/api/models/update_organization_plan_request.py index fca379be..7362e310 100644 --- a/koyeb/api/models/update_organization_plan_request.py +++ b/koyeb/api/models/update_organization_plan_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/update_organization_reply.py b/koyeb/api/models/update_organization_reply.py index 624d4192..bfbf9658 100644 --- a/koyeb/api/models/update_organization_reply.py +++ b/koyeb/api/models/update_organization_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/update_password_request.py b/koyeb/api/models/update_password_request.py index 14dd558e..7b98846d 100644 --- a/koyeb/api/models/update_password_request.py +++ b/koyeb/api/models/update_password_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/update_persistent_volume_reply.py b/koyeb/api/models/update_persistent_volume_reply.py index adc613cf..efe7aa03 100644 --- a/koyeb/api/models/update_persistent_volume_reply.py +++ b/koyeb/api/models/update_persistent_volume_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/update_persistent_volume_request.py b/koyeb/api/models/update_persistent_volume_request.py index 26974afa..7e24305b 100644 --- a/koyeb/api/models/update_persistent_volume_request.py +++ b/koyeb/api/models/update_persistent_volume_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/update_project_reply.py b/koyeb/api/models/update_project_reply.py index 8fc38a9f..15b88674 100644 --- a/koyeb/api/models/update_project_reply.py +++ b/koyeb/api/models/update_project_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/update_secret_reply.py b/koyeb/api/models/update_secret_reply.py index f0e0d9e5..f781989f 100644 --- a/koyeb/api/models/update_secret_reply.py +++ b/koyeb/api/models/update_secret_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/update_service.py b/koyeb/api/models/update_service.py index 0ef296be..35ec1a8b 100644 --- a/koyeb/api/models/update_service.py +++ b/koyeb/api/models/update_service.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/update_service_pool.py b/koyeb/api/models/update_service_pool.py index a9b5894f..8f967cd2 100644 --- a/koyeb/api/models/update_service_pool.py +++ b/koyeb/api/models/update_service_pool.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/update_service_pool_reply.py b/koyeb/api/models/update_service_pool_reply.py index 473ad995..67d2448c 100644 --- a/koyeb/api/models/update_service_pool_reply.py +++ b/koyeb/api/models/update_service_pool_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/update_service_reply.py b/koyeb/api/models/update_service_reply.py index cc94eadd..47340f0d 100644 --- a/koyeb/api/models/update_service_reply.py +++ b/koyeb/api/models/update_service_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/update_service_scaling_request.py b/koyeb/api/models/update_service_scaling_request.py index c7476e86..72327eb3 100644 --- a/koyeb/api/models/update_service_scaling_request.py +++ b/koyeb/api/models/update_service_scaling_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/update_snapshot_reply.py b/koyeb/api/models/update_snapshot_reply.py index d9a81706..6043caec 100644 --- a/koyeb/api/models/update_snapshot_reply.py +++ b/koyeb/api/models/update_snapshot_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/update_snapshot_request.py b/koyeb/api/models/update_snapshot_request.py index f466cbee..0fa3d6b6 100644 --- a/koyeb/api/models/update_snapshot_request.py +++ b/koyeb/api/models/update_snapshot_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/update_user_request_user_update_body.py b/koyeb/api/models/update_user_request_user_update_body.py index 0769c582..71462e9c 100644 --- a/koyeb/api/models/update_user_request_user_update_body.py +++ b/koyeb/api/models/update_user_request_user_update_body.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/update_user_settings_reply.py b/koyeb/api/models/update_user_settings_reply.py index e7c20f2e..d2f1743b 100644 --- a/koyeb/api/models/update_user_settings_reply.py +++ b/koyeb/api/models/update_user_settings_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/update_user_settings_request.py b/koyeb/api/models/update_user_settings_request.py index 0dd06786..e0b2c961 100644 --- a/koyeb/api/models/update_user_settings_request.py +++ b/koyeb/api/models/update_user_settings_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/upsert_signup_qualification_reply.py b/koyeb/api/models/upsert_signup_qualification_reply.py index 9d959718..e7e1363c 100644 --- a/koyeb/api/models/upsert_signup_qualification_reply.py +++ b/koyeb/api/models/upsert_signup_qualification_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/upsert_signup_qualification_request.py b/koyeb/api/models/upsert_signup_qualification_request.py index 3391bbb9..aed84ec8 100644 --- a/koyeb/api/models/upsert_signup_qualification_request.py +++ b/koyeb/api/models/upsert_signup_qualification_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/usage.py b/koyeb/api/models/usage.py index a4feb551..c214fa78 100644 --- a/koyeb/api/models/usage.py +++ b/koyeb/api/models/usage.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/usage_details.py b/koyeb/api/models/usage_details.py index 4476e91f..7bf25c8c 100644 --- a/koyeb/api/models/usage_details.py +++ b/koyeb/api/models/usage_details.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/user.py b/koyeb/api/models/user.py index 9a0192eb..453f71ec 100644 --- a/koyeb/api/models/user.py +++ b/koyeb/api/models/user.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/user_flags.py b/koyeb/api/models/user_flags.py index d17ba64c..7c300c58 100644 --- a/koyeb/api/models/user_flags.py +++ b/koyeb/api/models/user_flags.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/user_reply.py b/koyeb/api/models/user_reply.py index 43a3c1ce..714cb599 100644 --- a/koyeb/api/models/user_reply.py +++ b/koyeb/api/models/user_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/user_role_role.py b/koyeb/api/models/user_role_role.py index 900874be..e3c79944 100644 --- a/koyeb/api/models/user_role_role.py +++ b/koyeb/api/models/user_role_role.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/user_settings.py b/koyeb/api/models/user_settings.py index 3e77725c..c8d0f9d3 100644 --- a/koyeb/api/models/user_settings.py +++ b/koyeb/api/models/user_settings.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/verify_docker_image_reply.py b/koyeb/api/models/verify_docker_image_reply.py index d9414c7a..4a2b5735 100644 --- a/koyeb/api/models/verify_docker_image_reply.py +++ b/koyeb/api/models/verify_docker_image_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/models/verify_docker_image_reply_err_code.py b/koyeb/api/models/verify_docker_image_reply_err_code.py index b3212b42..af55ddf2 100644 --- a/koyeb/api/models/verify_docker_image_reply_err_code.py +++ b/koyeb/api/models/verify_docker_image_reply_err_code.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/rest.py b/koyeb/api/rest.py index 69988552..b0b3d0f5 100644 --- a/koyeb/api/rest.py +++ b/koyeb/api/rest.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api/test/test_archive_status.py b/koyeb/api/test/test_archive_status.py new file mode 100644 index 00000000..40cdf2d1 --- /dev/null +++ b/koyeb/api/test/test_archive_status.py @@ -0,0 +1,35 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from koyeb.api.models.archive_status import ArchiveStatus + + +class TestArchiveStatus(unittest.TestCase): + """ArchiveStatus unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testArchiveStatus(self): + """Test ArchiveStatus""" + # inst = ArchiveStatus() + + +if __name__ == "__main__": + unittest.main() diff --git a/koyeb/api/test/test_get_archive_reply.py b/koyeb/api/test/test_get_archive_reply.py new file mode 100644 index 00000000..77c5a6ad --- /dev/null +++ b/koyeb/api/test/test_get_archive_reply.py @@ -0,0 +1,62 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from koyeb.api.models.get_archive_reply import GetArchiveReply + + +class TestGetArchiveReply(unittest.TestCase): + """GetArchiveReply unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> GetArchiveReply: + """Test GetArchiveReply + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included""" + # uncomment below to create an instance of `GetArchiveReply` + """ + model = GetArchiveReply() + if include_optional: + return GetArchiveReply( + archive = koyeb.api.models.archive.Archive( + id = '', + organization_id = '', + upload_url = '', + size = '', + created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + deleted_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + download_url = '', + download_url_deadline = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + status = 'ARCHIVE_STATUS_INVALID', ) + ) + else: + return GetArchiveReply( + ) + """ + + def testGetArchiveReply(self): + """Test GetArchiveReply""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == "__main__": + unittest.main() diff --git a/koyeb/api/test/test_kmeta_get_organization_workspace_quotas_reply.py b/koyeb/api/test/test_kmeta_get_organization_workspace_quotas_reply.py new file mode 100644 index 00000000..8debf7f2 --- /dev/null +++ b/koyeb/api/test/test_kmeta_get_organization_workspace_quotas_reply.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from koyeb.api.models.kmeta_get_organization_workspace_quotas_reply import ( + KmetaGetOrganizationWorkspaceQuotasReply, +) + + +class TestKmetaGetOrganizationWorkspaceQuotasReply(unittest.TestCase): + """KmetaGetOrganizationWorkspaceQuotasReply unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance( + self, include_optional + ) -> KmetaGetOrganizationWorkspaceQuotasReply: + """Test KmetaGetOrganizationWorkspaceQuotasReply + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included""" + # uncomment below to create an instance of `KmetaGetOrganizationWorkspaceQuotasReply` + """ + model = KmetaGetOrganizationWorkspaceQuotasReply() + if include_optional: + return KmetaGetOrganizationWorkspaceQuotasReply( + quotas = koyeb.api.models.quotas.Quotas( + apps = '', + services = '', + domains = '', + service_provisioning_concurrency = '', + memory_mb = '', + instance_types = [ + '' + ], + regions = [ + '' + ], + max_organization_members = '', + max_instances_by_type = { + 'key' : '' + }, + persistent_volumes_by_region = { + 'key' : koyeb.api.models.persistent_volume_quotas.PersistentVolumeQuotas( + max_total_size = 56, + max_volume_size = 56, + max_per_instance_size = 56, ) + }, + custom_domains = '', + domains_load_balancer = koyeb.api.models.domain_load_balancer_quotas.DomainLoadBalancerQuotas( + max_koyeb = 56, ), + metrics_retention = 56, + logs_retention = 56, + access_reserved_subdomains = [ + '' + ], + proxy_ports = 56, + scale_to_zero = koyeb.api.models.scale_to_zero_quotas.ScaleToZeroQuotas( + is_deep_sleep_enabled = True, + deep_sleep_idle_delay_min = 56, + deep_sleep_idle_delay_max = 56, + is_light_sleep_enabled = True, + light_sleep_idle_delay_min = 56, + light_sleep_idle_delay_max = 56, ), + archives = '', + archive_max_size_mb = '', + lifecycle = koyeb.api.models.lifecycle_quotas.LifecycleQuotas( + delete_after_sleep_min = 56, + delete_after_sleep_max = 56, + delete_after_create_min = 56, + delete_after_create_max = 56, ), + max_projects = '', + instance_snapshots = koyeb.api.models.instance_snapshot_quotas.InstanceSnapshotQuotas( + filesystem = 56, + full = 56, ), + persistent_volumes_disabled = True, ) + ) + else: + return KmetaGetOrganizationWorkspaceQuotasReply( + ) + """ + + def testKmetaGetOrganizationWorkspaceQuotasReply(self): + """Test KmetaGetOrganizationWorkspaceQuotasReply""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == "__main__": + unittest.main() diff --git a/koyeb/api/test/test_list_archives_reply.py b/koyeb/api/test/test_list_archives_reply.py new file mode 100644 index 00000000..d8a65bd5 --- /dev/null +++ b/koyeb/api/test/test_list_archives_reply.py @@ -0,0 +1,68 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from koyeb.api.models.list_archives_reply import ListArchivesReply + + +class TestListArchivesReply(unittest.TestCase): + """ListArchivesReply unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ListArchivesReply: + """Test ListArchivesReply + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included""" + # uncomment below to create an instance of `ListArchivesReply` + """ + model = ListArchivesReply() + if include_optional: + return ListArchivesReply( + archives = [ + koyeb.api.models.archive.Archive( + id = '', + organization_id = '', + upload_url = '', + size = '', + created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + deleted_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + download_url = '', + download_url_deadline = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + status = 'ARCHIVE_STATUS_INVALID', ) + ], + limit = 56, + offset = 56, + count = 56, + has_next = True + ) + else: + return ListArchivesReply( + ) + """ + + def testListArchivesReply(self): + """Test ListArchivesReply""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == "__main__": + unittest.main() diff --git a/koyeb/api/test/test_query_services_view_filters.py b/koyeb/api/test/test_query_services_view_filters.py new file mode 100644 index 00000000..bd5977ba --- /dev/null +++ b/koyeb/api/test/test_query_services_view_filters.py @@ -0,0 +1,71 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from koyeb.api.models.query_services_view_filters import QueryServicesViewFilters + + +class TestQueryServicesViewFilters(unittest.TestCase): + """QueryServicesViewFilters unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> QueryServicesViewFilters: + """Test QueryServicesViewFilters + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included""" + # uncomment below to create an instance of `QueryServicesViewFilters` + """ + model = QueryServicesViewFilters() + if include_optional: + return QueryServicesViewFilters( + types = [ + 'INVALID_TYPE' + ], + statuses = [ + 'STARTING' + ], + regions = [ + '' + ], + app_ids = [ + '' + ], + active_deployment_states = [ + 'NONE' + ], + latest_deployment_states = [ + 'NONE' + ], + needs_attention = True + ) + else: + return QueryServicesViewFilters( + ) + """ + + def testQueryServicesViewFilters(self): + """Test QueryServicesViewFilters""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == "__main__": + unittest.main() diff --git a/koyeb/api/test/test_query_services_view_reply.py b/koyeb/api/test/test_query_services_view_reply.py new file mode 100644 index 00000000..91bb534e --- /dev/null +++ b/koyeb/api/test/test_query_services_view_reply.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from koyeb.api.models.query_services_view_reply import QueryServicesViewReply + + +class TestQueryServicesViewReply(unittest.TestCase): + """QueryServicesViewReply unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> QueryServicesViewReply: + """Test QueryServicesViewReply + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included""" + # uncomment below to create an instance of `QueryServicesViewReply` + """ + model = QueryServicesViewReply() + if include_optional: + return QueryServicesViewReply( + services = [ + koyeb.api.models.service_view_row.ServiceViewRow( + id = '', + name = '', + type = 'INVALID_TYPE', + status = 'STARTING', + messages = [ + '' + ], + created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + app_id = '', + app = koyeb.api.models.service_view_app.ServiceViewApp( + id = '', + name = '', ), + active_deployment = koyeb.api.models.service_view_active_deployment.ServiceViewActiveDeployment( + state = 'NONE', + id = '', + missing = True, + status = 'PENDING', + created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ), + latest_deployment = koyeb.api.models.service_view_latest_deployment.ServiceViewLatestDeployment( + state = 'NONE', + id = '', + missing = True, + status = 'PENDING', + created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ), + needs_attention = True, + regions = [ + '' + ], + instance_type = '', + source = koyeb.api.models.service_view_source.ServiceViewSource( + type = 'UNKNOWN', + reference = '', ), ) + ], + groups = [ + koyeb.api.models.service_view_group.ServiceViewGroup( + by = 'NO_GROUP', + key = '', + label = '', + count = 56, ) + ], + facets = [ + koyeb.api.models.service_view_facet.ServiceViewFacet( + kind = 'TYPE', + values = [ + koyeb.api.models.service_view_facet_value.ServiceViewFacetValue( + value = '', + label = '', + count = 56, ) + ], ) + ], + limit = 56, + offset = 56, + count = 56, + has_next = True + ) + else: + return QueryServicesViewReply( + ) + """ + + def testQueryServicesViewReply(self): + """Test QueryServicesViewReply""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == "__main__": + unittest.main() diff --git a/koyeb/api/test/test_query_services_view_sort.py b/koyeb/api/test/test_query_services_view_sort.py new file mode 100644 index 00000000..fdc5eb74 --- /dev/null +++ b/koyeb/api/test/test_query_services_view_sort.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from koyeb.api.models.query_services_view_sort import QueryServicesViewSort + + +class TestQueryServicesViewSort(unittest.TestCase): + """QueryServicesViewSort unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> QueryServicesViewSort: + """Test QueryServicesViewSort + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included""" + # uncomment below to create an instance of `QueryServicesViewSort` + """ + model = QueryServicesViewSort() + if include_optional: + return QueryServicesViewSort( + var_field = 'CREATED_AT', + direction = 'ASC' + ) + else: + return QueryServicesViewSort( + ) + """ + + def testQueryServicesViewSort(self): + """Test QueryServicesViewSort""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == "__main__": + unittest.main() diff --git a/koyeb/api/test/test_query_services_view_sort_direction.py b/koyeb/api/test/test_query_services_view_sort_direction.py new file mode 100644 index 00000000..ebd42fa8 --- /dev/null +++ b/koyeb/api/test/test_query_services_view_sort_direction.py @@ -0,0 +1,37 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from koyeb.api.models.query_services_view_sort_direction import ( + QueryServicesViewSortDirection, +) + + +class TestQueryServicesViewSortDirection(unittest.TestCase): + """QueryServicesViewSortDirection unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testQueryServicesViewSortDirection(self): + """Test QueryServicesViewSortDirection""" + # inst = QueryServicesViewSortDirection() + + +if __name__ == "__main__": + unittest.main() diff --git a/koyeb/api/test/test_query_services_view_sort_field.py b/koyeb/api/test/test_query_services_view_sort_field.py new file mode 100644 index 00000000..72ac21ee --- /dev/null +++ b/koyeb/api/test/test_query_services_view_sort_field.py @@ -0,0 +1,35 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from koyeb.api.models.query_services_view_sort_field import QueryServicesViewSortField + + +class TestQueryServicesViewSortField(unittest.TestCase): + """QueryServicesViewSortField unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testQueryServicesViewSortField(self): + """Test QueryServicesViewSortField""" + # inst = QueryServicesViewSortField() + + +if __name__ == "__main__": + unittest.main() diff --git a/koyeb/api/test/test_service_view_active_deployment.py b/koyeb/api/test/test_service_view_active_deployment.py new file mode 100644 index 00000000..2eff2bad --- /dev/null +++ b/koyeb/api/test/test_service_view_active_deployment.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from koyeb.api.models.service_view_active_deployment import ServiceViewActiveDeployment + + +class TestServiceViewActiveDeployment(unittest.TestCase): + """ServiceViewActiveDeployment unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServiceViewActiveDeployment: + """Test ServiceViewActiveDeployment + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included""" + # uncomment below to create an instance of `ServiceViewActiveDeployment` + """ + model = ServiceViewActiveDeployment() + if include_optional: + return ServiceViewActiveDeployment( + state = 'NONE', + id = '', + missing = True, + status = 'PENDING', + created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f') + ) + else: + return ServiceViewActiveDeployment( + ) + """ + + def testServiceViewActiveDeployment(self): + """Test ServiceViewActiveDeployment""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == "__main__": + unittest.main() diff --git a/koyeb/api/test/test_service_view_active_deployment_state.py b/koyeb/api/test/test_service_view_active_deployment_state.py new file mode 100644 index 00000000..e09901aa --- /dev/null +++ b/koyeb/api/test/test_service_view_active_deployment_state.py @@ -0,0 +1,37 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from koyeb.api.models.service_view_active_deployment_state import ( + ServiceViewActiveDeploymentState, +) + + +class TestServiceViewActiveDeploymentState(unittest.TestCase): + """ServiceViewActiveDeploymentState unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testServiceViewActiveDeploymentState(self): + """Test ServiceViewActiveDeploymentState""" + # inst = ServiceViewActiveDeploymentState() + + +if __name__ == "__main__": + unittest.main() diff --git a/koyeb/api/test/test_service_view_app.py b/koyeb/api/test/test_service_view_app.py new file mode 100644 index 00000000..d4b63640 --- /dev/null +++ b/koyeb/api/test/test_service_view_app.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from koyeb.api.models.service_view_app import ServiceViewApp + + +class TestServiceViewApp(unittest.TestCase): + """ServiceViewApp unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServiceViewApp: + """Test ServiceViewApp + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included""" + # uncomment below to create an instance of `ServiceViewApp` + """ + model = ServiceViewApp() + if include_optional: + return ServiceViewApp( + id = '', + name = '' + ) + else: + return ServiceViewApp( + ) + """ + + def testServiceViewApp(self): + """Test ServiceViewApp""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == "__main__": + unittest.main() diff --git a/koyeb/api/test/test_service_view_facet.py b/koyeb/api/test/test_service_view_facet.py new file mode 100644 index 00000000..28e56e20 --- /dev/null +++ b/koyeb/api/test/test_service_view_facet.py @@ -0,0 +1,59 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from koyeb.api.models.service_view_facet import ServiceViewFacet + + +class TestServiceViewFacet(unittest.TestCase): + """ServiceViewFacet unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServiceViewFacet: + """Test ServiceViewFacet + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included""" + # uncomment below to create an instance of `ServiceViewFacet` + """ + model = ServiceViewFacet() + if include_optional: + return ServiceViewFacet( + kind = 'TYPE', + values = [ + koyeb.api.models.service_view_facet_value.ServiceViewFacetValue( + value = '', + label = '', + count = 56, ) + ] + ) + else: + return ServiceViewFacet( + ) + """ + + def testServiceViewFacet(self): + """Test ServiceViewFacet""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == "__main__": + unittest.main() diff --git a/koyeb/api/test/test_service_view_facet_kind.py b/koyeb/api/test/test_service_view_facet_kind.py new file mode 100644 index 00000000..72484dc6 --- /dev/null +++ b/koyeb/api/test/test_service_view_facet_kind.py @@ -0,0 +1,35 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from koyeb.api.models.service_view_facet_kind import ServiceViewFacetKind + + +class TestServiceViewFacetKind(unittest.TestCase): + """ServiceViewFacetKind unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testServiceViewFacetKind(self): + """Test ServiceViewFacetKind""" + # inst = ServiceViewFacetKind() + + +if __name__ == "__main__": + unittest.main() diff --git a/koyeb/api/test/test_service_view_facet_value.py b/koyeb/api/test/test_service_view_facet_value.py new file mode 100644 index 00000000..5537c5a7 --- /dev/null +++ b/koyeb/api/test/test_service_view_facet_value.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from koyeb.api.models.service_view_facet_value import ServiceViewFacetValue + + +class TestServiceViewFacetValue(unittest.TestCase): + """ServiceViewFacetValue unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServiceViewFacetValue: + """Test ServiceViewFacetValue + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included""" + # uncomment below to create an instance of `ServiceViewFacetValue` + """ + model = ServiceViewFacetValue() + if include_optional: + return ServiceViewFacetValue( + value = '', + label = '', + count = 56 + ) + else: + return ServiceViewFacetValue( + ) + """ + + def testServiceViewFacetValue(self): + """Test ServiceViewFacetValue""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == "__main__": + unittest.main() diff --git a/koyeb/api/test/test_service_view_group.py b/koyeb/api/test/test_service_view_group.py new file mode 100644 index 00000000..2497b2d8 --- /dev/null +++ b/koyeb/api/test/test_service_view_group.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from koyeb.api.models.service_view_group import ServiceViewGroup + + +class TestServiceViewGroup(unittest.TestCase): + """ServiceViewGroup unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServiceViewGroup: + """Test ServiceViewGroup + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included""" + # uncomment below to create an instance of `ServiceViewGroup` + """ + model = ServiceViewGroup() + if include_optional: + return ServiceViewGroup( + by = 'NO_GROUP', + key = '', + label = '', + count = 56 + ) + else: + return ServiceViewGroup( + ) + """ + + def testServiceViewGroup(self): + """Test ServiceViewGroup""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == "__main__": + unittest.main() diff --git a/koyeb/api/test/test_service_view_group_by.py b/koyeb/api/test/test_service_view_group_by.py new file mode 100644 index 00000000..2410f57d --- /dev/null +++ b/koyeb/api/test/test_service_view_group_by.py @@ -0,0 +1,35 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from koyeb.api.models.service_view_group_by import ServiceViewGroupBy + + +class TestServiceViewGroupBy(unittest.TestCase): + """ServiceViewGroupBy unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testServiceViewGroupBy(self): + """Test ServiceViewGroupBy""" + # inst = ServiceViewGroupBy() + + +if __name__ == "__main__": + unittest.main() diff --git a/koyeb/api/test/test_service_view_latest_deployment.py b/koyeb/api/test/test_service_view_latest_deployment.py new file mode 100644 index 00000000..36f9d695 --- /dev/null +++ b/koyeb/api/test/test_service_view_latest_deployment.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from koyeb.api.models.service_view_latest_deployment import ServiceViewLatestDeployment + + +class TestServiceViewLatestDeployment(unittest.TestCase): + """ServiceViewLatestDeployment unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServiceViewLatestDeployment: + """Test ServiceViewLatestDeployment + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included""" + # uncomment below to create an instance of `ServiceViewLatestDeployment` + """ + model = ServiceViewLatestDeployment() + if include_optional: + return ServiceViewLatestDeployment( + state = 'NONE', + id = '', + missing = True, + status = 'PENDING', + created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f') + ) + else: + return ServiceViewLatestDeployment( + ) + """ + + def testServiceViewLatestDeployment(self): + """Test ServiceViewLatestDeployment""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == "__main__": + unittest.main() diff --git a/koyeb/api/test/test_service_view_latest_deployment_state.py b/koyeb/api/test/test_service_view_latest_deployment_state.py new file mode 100644 index 00000000..5565e064 --- /dev/null +++ b/koyeb/api/test/test_service_view_latest_deployment_state.py @@ -0,0 +1,37 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from koyeb.api.models.service_view_latest_deployment_state import ( + ServiceViewLatestDeploymentState, +) + + +class TestServiceViewLatestDeploymentState(unittest.TestCase): + """ServiceViewLatestDeploymentState unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testServiceViewLatestDeploymentState(self): + """Test ServiceViewLatestDeploymentState""" + # inst = ServiceViewLatestDeploymentState() + + +if __name__ == "__main__": + unittest.main() diff --git a/koyeb/api/test/test_service_view_row.py b/koyeb/api/test/test_service_view_row.py new file mode 100644 index 00000000..027a9989 --- /dev/null +++ b/koyeb/api/test/test_service_view_row.py @@ -0,0 +1,87 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from koyeb.api.models.service_view_row import ServiceViewRow + + +class TestServiceViewRow(unittest.TestCase): + """ServiceViewRow unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServiceViewRow: + """Test ServiceViewRow + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included""" + # uncomment below to create an instance of `ServiceViewRow` + """ + model = ServiceViewRow() + if include_optional: + return ServiceViewRow( + id = '', + name = '', + type = 'INVALID_TYPE', + status = 'STARTING', + messages = [ + '' + ], + created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + app_id = '', + app = koyeb.api.models.service_view_app.ServiceViewApp( + id = '', + name = '', ), + active_deployment = koyeb.api.models.service_view_active_deployment.ServiceViewActiveDeployment( + state = 'NONE', + id = '', + missing = True, + status = 'PENDING', + created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ), + latest_deployment = koyeb.api.models.service_view_latest_deployment.ServiceViewLatestDeployment( + state = 'NONE', + id = '', + missing = True, + status = 'PENDING', + created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ), + needs_attention = True, + regions = [ + '' + ], + instance_type = '', + source = koyeb.api.models.service_view_source.ServiceViewSource( + type = 'UNKNOWN', + reference = '', ) + ) + else: + return ServiceViewRow( + ) + """ + + def testServiceViewRow(self): + """Test ServiceViewRow""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == "__main__": + unittest.main() diff --git a/koyeb/api/test/test_service_view_source.py b/koyeb/api/test/test_service_view_source.py new file mode 100644 index 00000000..db3ca37b --- /dev/null +++ b/koyeb/api/test/test_service_view_source.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from koyeb.api.models.service_view_source import ServiceViewSource + + +class TestServiceViewSource(unittest.TestCase): + """ServiceViewSource unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServiceViewSource: + """Test ServiceViewSource + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included""" + # uncomment below to create an instance of `ServiceViewSource` + """ + model = ServiceViewSource() + if include_optional: + return ServiceViewSource( + type = 'UNKNOWN', + reference = '' + ) + else: + return ServiceViewSource( + ) + """ + + def testServiceViewSource(self): + """Test ServiceViewSource""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == "__main__": + unittest.main() diff --git a/koyeb/api/test/test_service_view_source_type.py b/koyeb/api/test/test_service_view_source_type.py new file mode 100644 index 00000000..6780c685 --- /dev/null +++ b/koyeb/api/test/test_service_view_source_type.py @@ -0,0 +1,35 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from koyeb.api.models.service_view_source_type import ServiceViewSourceType + + +class TestServiceViewSourceType(unittest.TestCase): + """ServiceViewSourceType unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testServiceViewSourceType(self): + """Test ServiceViewSourceType""" + # inst = ServiceViewSourceType() + + +if __name__ == "__main__": + unittest.main() diff --git a/koyeb/api/test/test_service_views_api.py b/koyeb/api/test/test_service_views_api.py new file mode 100644 index 00000000..4c8296dc --- /dev/null +++ b/koyeb/api/test/test_service_views_api.py @@ -0,0 +1,38 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from koyeb.api.api.service_views_api import ServiceViewsApi + + +class TestServiceViewsApi(unittest.TestCase): + """ServiceViewsApi unit test stubs""" + + def setUp(self) -> None: + self.api = ServiceViewsApi() + + def tearDown(self) -> None: + pass + + def test_query_services_view(self) -> None: + """Test case for query_services_view + + Query the Services view + """ + pass + + +if __name__ == "__main__": + unittest.main() diff --git a/koyeb/api_README.md b/koyeb/api_README.md index 145a28b7..cbd285b1 100644 --- a/koyeb/api_README.md +++ b/koyeb/api_README.md @@ -1,16 +1,16 @@ # koyeb.api -The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. +Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The `koyeb.api` package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: - API version: 1.0.0 -- Package version: 1.6.1 -- Generator version: 7.27.0-SNAPSHOT +- Package version: 1.6.2 +- Generator version: 7.28.0-SNAPSHOT - Build package: org.openapitools.codegen.languages.PythonClientCodegen ## Requirements. -Python 3.10+ +Python 3.11+ ## Installation & Usage @@ -84,6 +84,9 @@ Class | Method | HTTP request | Description *AppsApi* | [**update_app**](koyeb/api/docs/AppsApi.md#update_app) | **PUT** /v1/apps/{id} | Update App *AppsApi* | [**update_app2**](koyeb/api/docs/AppsApi.md#update_app2) | **PATCH** /v1/apps/{id} | Update App *ArchivesApi* | [**create_archive**](koyeb/api/docs/ArchivesApi.md#create_archive) | **POST** /v1/archives | Create Archive +*ArchivesApi* | [**delete_archive**](koyeb/api/docs/ArchivesApi.md#delete_archive) | **DELETE** /v1/archives/{id} | Delete Archive +*ArchivesApi* | [**get_archive**](koyeb/api/docs/ArchivesApi.md#get_archive) | **GET** /v1/archives/{id} | Get Archive +*ArchivesApi* | [**list_archives**](koyeb/api/docs/ArchivesApi.md#list_archives) | **GET** /v1/archives | List Archives *CatalogDatacentersApi* | [**list_datacenters**](koyeb/api/docs/CatalogDatacentersApi.md#list_datacenters) | **GET** /v1/catalog/datacenters | List datacenters *CatalogInstanceUsageApi* | [**list_usage**](koyeb/api/docs/CatalogInstanceUsageApi.md#list_usage) | **GET** /v1/catalog/usage | *CatalogInstancesApi* | [**get_catalog_instance**](koyeb/api/docs/CatalogInstancesApi.md#get_catalog_instance) | **GET** /v1/catalog/instances/{id} | Get Instance @@ -180,6 +183,7 @@ Class | Method | HTTP request | Description *ProvisioningApi* | [**declare_stage_progress**](koyeb/api/docs/ProvisioningApi.md#declare_stage_progress) | **PATCH** /v1/provisioning/{deployment_id}/status/{stage}/{attempt} | Declare stage progress *ProvisioningApi* | [**declare_step_progress**](koyeb/api/docs/ProvisioningApi.md#declare_step_progress) | **PATCH** /v1/provisioning/{deployment_id}/status/{stage}/{attempt}/{step} | Declare step progress *QuotasApi* | [**get_organization_quotas_usage**](koyeb/api/docs/QuotasApi.md#get_organization_quotas_usage) | **GET** /v1/quotas/organizations/{organization_id}/usage | Return the organization's current quota usage alongside the plan's limits. Response is cached in Redis for 60s. Accept text/plain (or ?format=prometheus) to receive the response rendered as Prometheus text exposition format (\"koyeb_quota_<x>\" for usage, \"koyeb_quota_<x>_limit\" for the plan limit) suitable for scraping into an external Prometheus. +*QuotasApi* | [**get_organization_workspace_quotas**](koyeb/api/docs/QuotasApi.md#get_organization_workspace_quotas) | **GET** /v1/quotas/organizations/{organization_id}/{workspace_id}/quotas | *QuotasApi* | [**review_organization_capacity**](koyeb/api/docs/QuotasApi.md#review_organization_capacity) | **POST** /v1/quotas/capacity | DEPRECATED: Review Organization Capacity *RegionalDeploymentsApi* | [**get_regional_deployment**](koyeb/api/docs/RegionalDeploymentsApi.md#get_regional_deployment) | **GET** /v1/regional_deployments/{id} | Get Regional Deployment *RegionalDeploymentsApi* | [**list_regional_deployment_events**](koyeb/api/docs/RegionalDeploymentsApi.md#list_regional_deployment_events) | **GET** /v1/regional_deployment_events | List Regional Deployment events @@ -200,6 +204,7 @@ Class | Method | HTTP request | Description *ServicePoolsApi* | [**get_service_pool**](koyeb/api/docs/ServicePoolsApi.md#get_service_pool) | **GET** /v1/service_pools/{id} | Get a ServicePool *ServicePoolsApi* | [**list_service_pools**](koyeb/api/docs/ServicePoolsApi.md#list_service_pools) | **GET** /v1/service_pools | List ServicePools *ServicePoolsApi* | [**update_service_pool**](koyeb/api/docs/ServicePoolsApi.md#update_service_pool) | **PUT** /v1/service_pools/{id} | +*ServiceViewsApi* | [**query_services_view**](koyeb/api/docs/ServiceViewsApi.md#query_services_view) | **GET** /v1/views/services | Query the Services view *ServicesApi* | [**autocomplete**](koyeb/api/docs/ServicesApi.md#autocomplete) | **POST** /v1/services-autocomplete | Autocomplete definition *ServicesApi* | [**create_service**](koyeb/api/docs/ServicesApi.md#create_service) | **POST** /v1/services | Create Service *ServicesApi* | [**delete_service**](koyeb/api/docs/ServicesApi.md#delete_service) | **DELETE** /v1/services/{id} | Delete Service @@ -278,6 +283,7 @@ Class | Method | HTTP request | Description - [Archive](koyeb/api/docs/Archive.md) - [ArchiveDeploymentMetadata](koyeb/api/docs/ArchiveDeploymentMetadata.md) - [ArchiveSource](koyeb/api/docs/ArchiveSource.md) + - [ArchiveStatus](koyeb/api/docs/ArchiveStatus.md) - [AutoRelease](koyeb/api/docs/AutoRelease.md) - [AutoReleaseGroup](koyeb/api/docs/AutoReleaseGroup.md) - [AutocompleteReply](koyeb/api/docs/AutocompleteReply.md) @@ -412,6 +418,7 @@ Class | Method | HTTP request | Description - [GCPContainerRegistryConfiguration](koyeb/api/docs/GCPContainerRegistryConfiguration.md) - [GRPCHealthCheck](koyeb/api/docs/GRPCHealthCheck.md) - [GetAppReply](koyeb/api/docs/GetAppReply.md) + - [GetArchiveReply](koyeb/api/docs/GetArchiveReply.md) - [GetBudgetReply](koyeb/api/docs/GetBudgetReply.md) - [GetCatalogInstanceReply](koyeb/api/docs/GetCatalogInstanceReply.md) - [GetCredentialReply](koyeb/api/docs/GetCredentialReply.md) @@ -484,6 +491,7 @@ Class | Method | HTTP request | Description - [KgitproxyListRepositoriesReply](koyeb/api/docs/KgitproxyListRepositoriesReply.md) - [KgitproxyRepository](koyeb/api/docs/KgitproxyRepository.md) - [KgitproxyRepositoryProvider](koyeb/api/docs/KgitproxyRepositoryProvider.md) + - [KmetaGetOrganizationWorkspaceQuotasReply](koyeb/api/docs/KmetaGetOrganizationWorkspaceQuotasReply.md) - [KsearchApp](koyeb/api/docs/KsearchApp.md) - [KsearchGlobalDeployment](koyeb/api/docs/KsearchGlobalDeployment.md) - [KsearchInstance](koyeb/api/docs/KsearchInstance.md) @@ -497,6 +505,7 @@ Class | Method | HTTP request | Description - [LifecycleQuotas](koyeb/api/docs/LifecycleQuotas.md) - [ListAppEventsReply](koyeb/api/docs/ListAppEventsReply.md) - [ListAppsReply](koyeb/api/docs/ListAppsReply.md) + - [ListArchivesReply](koyeb/api/docs/ListArchivesReply.md) - [ListCatalogInstancesReply](koyeb/api/docs/ListCatalogInstancesReply.md) - [ListCredentialsReply](koyeb/api/docs/ListCredentialsReply.md) - [ListDatacentersReply](koyeb/api/docs/ListDatacentersReply.md) @@ -586,6 +595,11 @@ Class | Method | HTTP request | Description - [PublicUser](koyeb/api/docs/PublicUser.md) - [QueryLogsReply](koyeb/api/docs/QueryLogsReply.md) - [QueryLogsReplyPagination](koyeb/api/docs/QueryLogsReplyPagination.md) + - [QueryServicesViewFilters](koyeb/api/docs/QueryServicesViewFilters.md) + - [QueryServicesViewReply](koyeb/api/docs/QueryServicesViewReply.md) + - [QueryServicesViewSort](koyeb/api/docs/QueryServicesViewSort.md) + - [QueryServicesViewSortDirection](koyeb/api/docs/QueryServicesViewSortDirection.md) + - [QueryServicesViewSortField](koyeb/api/docs/QueryServicesViewSortField.md) - [QuotaUsage](koyeb/api/docs/QuotaUsage.md) - [Quotas](koyeb/api/docs/Quotas.md) - [ReactivateOrganizationReply](koyeb/api/docs/ReactivateOrganizationReply.md) @@ -632,6 +646,19 @@ Class | Method | HTTP request | Description - [ServiceSummary](koyeb/api/docs/ServiceSummary.md) - [ServiceType](koyeb/api/docs/ServiceType.md) - [ServiceUsage](koyeb/api/docs/ServiceUsage.md) + - [ServiceViewActiveDeployment](koyeb/api/docs/ServiceViewActiveDeployment.md) + - [ServiceViewActiveDeploymentState](koyeb/api/docs/ServiceViewActiveDeploymentState.md) + - [ServiceViewApp](koyeb/api/docs/ServiceViewApp.md) + - [ServiceViewFacet](koyeb/api/docs/ServiceViewFacet.md) + - [ServiceViewFacetKind](koyeb/api/docs/ServiceViewFacetKind.md) + - [ServiceViewFacetValue](koyeb/api/docs/ServiceViewFacetValue.md) + - [ServiceViewGroup](koyeb/api/docs/ServiceViewGroup.md) + - [ServiceViewGroupBy](koyeb/api/docs/ServiceViewGroupBy.md) + - [ServiceViewLatestDeployment](koyeb/api/docs/ServiceViewLatestDeployment.md) + - [ServiceViewLatestDeploymentState](koyeb/api/docs/ServiceViewLatestDeploymentState.md) + - [ServiceViewRow](koyeb/api/docs/ServiceViewRow.md) + - [ServiceViewSource](koyeb/api/docs/ServiceViewSource.md) + - [ServiceViewSourceType](koyeb/api/docs/ServiceViewSourceType.md) - [Snapshot](koyeb/api/docs/Snapshot.md) - [SnapshotStatus](koyeb/api/docs/SnapshotStatus.md) - [SnapshotType](koyeb/api/docs/SnapshotType.md) diff --git a/koyeb/api_async/.openapi-generator/FILES b/koyeb/api_async/.openapi-generator/FILES index b2a20b6e..4d5135ec 100644 --- a/koyeb/api_async/.openapi-generator/FILES +++ b/koyeb/api_async/.openapi-generator/FILES @@ -38,6 +38,7 @@ koyeb/api_async/api/repositories_api.py koyeb/api_async/api/search_api.py koyeb/api_async/api/secrets_api.py koyeb/api_async/api/service_pools_api.py +koyeb/api_async/api/service_views_api.py koyeb/api_async/api/services_api.py koyeb/api_async/api/sessions_api.py koyeb/api_async/api/snapshots_api.py @@ -66,6 +67,7 @@ koyeb/api_async/docs/AppsSummary.md koyeb/api_async/docs/Archive.md koyeb/api_async/docs/ArchiveDeploymentMetadata.md koyeb/api_async/docs/ArchiveSource.md +koyeb/api_async/docs/ArchiveStatus.md koyeb/api_async/docs/ArchivesApi.md koyeb/api_async/docs/AutoRelease.md koyeb/api_async/docs/AutoReleaseGroup.md @@ -212,6 +214,7 @@ koyeb/api_async/docs/ExecCommandRequestTerminalSize.md koyeb/api_async/docs/GCPContainerRegistryConfiguration.md koyeb/api_async/docs/GRPCHealthCheck.md koyeb/api_async/docs/GetAppReply.md +koyeb/api_async/docs/GetArchiveReply.md koyeb/api_async/docs/GetBudgetReply.md koyeb/api_async/docs/GetCatalogInstanceReply.md koyeb/api_async/docs/GetCredentialReply.md @@ -288,6 +291,7 @@ koyeb/api_async/docs/KgitproxyListBranchesReply.md koyeb/api_async/docs/KgitproxyListRepositoriesReply.md koyeb/api_async/docs/KgitproxyRepository.md koyeb/api_async/docs/KgitproxyRepositoryProvider.md +koyeb/api_async/docs/KmetaGetOrganizationWorkspaceQuotasReply.md koyeb/api_async/docs/KsearchApp.md koyeb/api_async/docs/KsearchGlobalDeployment.md koyeb/api_async/docs/KsearchInstance.md @@ -301,6 +305,7 @@ koyeb/api_async/docs/KtestTestAuthRequest.md koyeb/api_async/docs/LifecycleQuotas.md koyeb/api_async/docs/ListAppEventsReply.md koyeb/api_async/docs/ListAppsReply.md +koyeb/api_async/docs/ListArchivesReply.md koyeb/api_async/docs/ListCatalogInstancesReply.md koyeb/api_async/docs/ListCredentialsReply.md koyeb/api_async/docs/ListDatacentersReply.md @@ -403,6 +408,11 @@ koyeb/api_async/docs/PublicOrganization.md koyeb/api_async/docs/PublicUser.md koyeb/api_async/docs/QueryLogsReply.md koyeb/api_async/docs/QueryLogsReplyPagination.md +koyeb/api_async/docs/QueryServicesViewFilters.md +koyeb/api_async/docs/QueryServicesViewReply.md +koyeb/api_async/docs/QueryServicesViewSort.md +koyeb/api_async/docs/QueryServicesViewSortDirection.md +koyeb/api_async/docs/QueryServicesViewSortField.md koyeb/api_async/docs/QuotaUsage.md koyeb/api_async/docs/Quotas.md koyeb/api_async/docs/QuotasApi.md @@ -455,6 +465,20 @@ koyeb/api_async/docs/ServiceStatus.md koyeb/api_async/docs/ServiceSummary.md koyeb/api_async/docs/ServiceType.md koyeb/api_async/docs/ServiceUsage.md +koyeb/api_async/docs/ServiceViewActiveDeployment.md +koyeb/api_async/docs/ServiceViewActiveDeploymentState.md +koyeb/api_async/docs/ServiceViewApp.md +koyeb/api_async/docs/ServiceViewFacet.md +koyeb/api_async/docs/ServiceViewFacetKind.md +koyeb/api_async/docs/ServiceViewFacetValue.md +koyeb/api_async/docs/ServiceViewGroup.md +koyeb/api_async/docs/ServiceViewGroupBy.md +koyeb/api_async/docs/ServiceViewLatestDeployment.md +koyeb/api_async/docs/ServiceViewLatestDeploymentState.md +koyeb/api_async/docs/ServiceViewRow.md +koyeb/api_async/docs/ServiceViewSource.md +koyeb/api_async/docs/ServiceViewSourceType.md +koyeb/api_async/docs/ServiceViewsApi.md koyeb/api_async/docs/ServicesApi.md koyeb/api_async/docs/SessionsApi.md koyeb/api_async/docs/Snapshot.md @@ -536,6 +560,7 @@ koyeb/api_async/models/apps_summary.py koyeb/api_async/models/archive.py koyeb/api_async/models/archive_deployment_metadata.py koyeb/api_async/models/archive_source.py +koyeb/api_async/models/archive_status.py koyeb/api_async/models/auto_release.py koyeb/api_async/models/auto_release_group.py koyeb/api_async/models/autocomplete_reply.py @@ -669,6 +694,7 @@ koyeb/api_async/models/exec_command_request_id_type.py koyeb/api_async/models/exec_command_request_terminal_size.py koyeb/api_async/models/gcp_container_registry_configuration.py koyeb/api_async/models/get_app_reply.py +koyeb/api_async/models/get_archive_reply.py koyeb/api_async/models/get_budget_reply.py koyeb/api_async/models/get_catalog_instance_reply.py koyeb/api_async/models/get_credential_reply.py @@ -742,6 +768,7 @@ koyeb/api_async/models/kgitproxy_list_branches_reply.py koyeb/api_async/models/kgitproxy_list_repositories_reply.py koyeb/api_async/models/kgitproxy_repository.py koyeb/api_async/models/kgitproxy_repository_provider.py +koyeb/api_async/models/kmeta_get_organization_workspace_quotas_reply.py koyeb/api_async/models/ksearch_app.py koyeb/api_async/models/ksearch_global_deployment.py koyeb/api_async/models/ksearch_instance.py @@ -755,6 +782,7 @@ koyeb/api_async/models/ktest_test_auth_request.py koyeb/api_async/models/lifecycle_quotas.py koyeb/api_async/models/list_app_events_reply.py koyeb/api_async/models/list_apps_reply.py +koyeb/api_async/models/list_archives_reply.py koyeb/api_async/models/list_catalog_instances_reply.py koyeb/api_async/models/list_credentials_reply.py koyeb/api_async/models/list_datacenters_reply.py @@ -844,6 +872,11 @@ koyeb/api_async/models/public_organization.py koyeb/api_async/models/public_user.py koyeb/api_async/models/query_logs_reply.py koyeb/api_async/models/query_logs_reply_pagination.py +koyeb/api_async/models/query_services_view_filters.py +koyeb/api_async/models/query_services_view_reply.py +koyeb/api_async/models/query_services_view_sort.py +koyeb/api_async/models/query_services_view_sort_direction.py +koyeb/api_async/models/query_services_view_sort_field.py koyeb/api_async/models/quota_usage.py koyeb/api_async/models/quotas.py koyeb/api_async/models/reactivate_organization_reply.py @@ -890,6 +923,19 @@ koyeb/api_async/models/service_status.py koyeb/api_async/models/service_summary.py koyeb/api_async/models/service_type.py koyeb/api_async/models/service_usage.py +koyeb/api_async/models/service_view_active_deployment.py +koyeb/api_async/models/service_view_active_deployment_state.py +koyeb/api_async/models/service_view_app.py +koyeb/api_async/models/service_view_facet.py +koyeb/api_async/models/service_view_facet_kind.py +koyeb/api_async/models/service_view_facet_value.py +koyeb/api_async/models/service_view_group.py +koyeb/api_async/models/service_view_group_by.py +koyeb/api_async/models/service_view_latest_deployment.py +koyeb/api_async/models/service_view_latest_deployment_state.py +koyeb/api_async/models/service_view_row.py +koyeb/api_async/models/service_view_source.py +koyeb/api_async/models/service_view_source_type.py koyeb/api_async/models/snapshot.py koyeb/api_async/models/snapshot_status.py koyeb/api_async/models/snapshot_type.py @@ -948,7 +994,27 @@ koyeb/api_async/models/verify_docker_image_reply.py koyeb/api_async/models/verify_docker_image_reply_err_code.py koyeb/api_async/rest.py koyeb/api_async/test/__init__.py -koyeb/api_async/test/test_docker_deployment_metadata.py -koyeb/api_async/test/test_grpc_health_check.py -koyeb/api_async/test/test_regional_deployment_metadata.py +koyeb/api_async/test/test_archive_status.py +koyeb/api_async/test/test_get_archive_reply.py +koyeb/api_async/test/test_kmeta_get_organization_workspace_quotas_reply.py +koyeb/api_async/test/test_list_archives_reply.py +koyeb/api_async/test/test_query_services_view_filters.py +koyeb/api_async/test/test_query_services_view_reply.py +koyeb/api_async/test/test_query_services_view_sort.py +koyeb/api_async/test/test_query_services_view_sort_direction.py +koyeb/api_async/test/test_query_services_view_sort_field.py +koyeb/api_async/test/test_service_view_active_deployment.py +koyeb/api_async/test/test_service_view_active_deployment_state.py +koyeb/api_async/test/test_service_view_app.py +koyeb/api_async/test/test_service_view_facet.py +koyeb/api_async/test/test_service_view_facet_kind.py +koyeb/api_async/test/test_service_view_facet_value.py +koyeb/api_async/test/test_service_view_group.py +koyeb/api_async/test/test_service_view_group_by.py +koyeb/api_async/test/test_service_view_latest_deployment.py +koyeb/api_async/test/test_service_view_latest_deployment_state.py +koyeb/api_async/test/test_service_view_row.py +koyeb/api_async/test/test_service_view_source.py +koyeb/api_async/test/test_service_view_source_type.py +koyeb/api_async/test/test_service_views_api.py koyeb/api_async_README.md diff --git a/koyeb/api_async/.openapi-generator/VERSION b/koyeb/api_async/.openapi-generator/VERSION index 56fe0e8b..84bf2cee 100644 --- a/koyeb/api_async/.openapi-generator/VERSION +++ b/koyeb/api_async/.openapi-generator/VERSION @@ -1 +1 @@ -7.27.0-SNAPSHOT +7.28.0-SNAPSHOT diff --git a/koyeb/api_async/__init__.py b/koyeb/api_async/__init__.py index 269e7def..ba3be2a6 100644 --- a/koyeb/api_async/__init__.py +++ b/koyeb/api_async/__init__.py @@ -5,7 +5,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -14,7 +14,7 @@ """ # noqa: E501 -__version__ = "1.6.1" +__version__ = "1.6.2" # Define package exports __all__ = [ @@ -51,6 +51,7 @@ "SearchApi", "SecretsApi", "ServicePoolsApi", + "ServiceViewsApi", "ServicesApi", "SessionsApi", "SnapshotsApi", @@ -87,6 +88,7 @@ "Archive", "ArchiveDeploymentMetadata", "ArchiveSource", + "ArchiveStatus", "AutoRelease", "AutoReleaseGroup", "AutocompleteReply", @@ -221,6 +223,7 @@ "GCPContainerRegistryConfiguration", "GRPCHealthCheck", "GetAppReply", + "GetArchiveReply", "GetBudgetReply", "GetCatalogInstanceReply", "GetCredentialReply", @@ -293,6 +296,7 @@ "KgitproxyListRepositoriesReply", "KgitproxyRepository", "KgitproxyRepositoryProvider", + "KmetaGetOrganizationWorkspaceQuotasReply", "KsearchApp", "KsearchGlobalDeployment", "KsearchInstance", @@ -306,6 +310,7 @@ "LifecycleQuotas", "ListAppEventsReply", "ListAppsReply", + "ListArchivesReply", "ListCatalogInstancesReply", "ListCredentialsReply", "ListDatacentersReply", @@ -395,6 +400,11 @@ "PublicUser", "QueryLogsReply", "QueryLogsReplyPagination", + "QueryServicesViewFilters", + "QueryServicesViewReply", + "QueryServicesViewSort", + "QueryServicesViewSortDirection", + "QueryServicesViewSortField", "QuotaUsage", "Quotas", "ReactivateOrganizationReply", @@ -441,6 +451,19 @@ "ServiceSummary", "ServiceType", "ServiceUsage", + "ServiceViewActiveDeployment", + "ServiceViewActiveDeploymentState", + "ServiceViewApp", + "ServiceViewFacet", + "ServiceViewFacetKind", + "ServiceViewFacetValue", + "ServiceViewGroup", + "ServiceViewGroupBy", + "ServiceViewLatestDeployment", + "ServiceViewLatestDeploymentState", + "ServiceViewRow", + "ServiceViewSource", + "ServiceViewSourceType", "Snapshot", "SnapshotStatus", "SnapshotType", @@ -557,6 +580,7 @@ from koyeb.api_async.api.search_api import SearchApi as SearchApi from koyeb.api_async.api.secrets_api import SecretsApi as SecretsApi from koyeb.api_async.api.service_pools_api import ServicePoolsApi as ServicePoolsApi +from koyeb.api_async.api.service_views_api import ServiceViewsApi as ServiceViewsApi from koyeb.api_async.api.services_api import ServicesApi as ServicesApi from koyeb.api_async.api.sessions_api import SessionsApi as SessionsApi from koyeb.api_async.api.snapshots_api import SnapshotsApi as SnapshotsApi @@ -601,6 +625,7 @@ ArchiveDeploymentMetadata as ArchiveDeploymentMetadata, ) from koyeb.api_async.models.archive_source import ArchiveSource as ArchiveSource +from koyeb.api_async.models.archive_status import ArchiveStatus as ArchiveStatus from koyeb.api_async.models.auto_release import AutoRelease as AutoRelease from koyeb.api_async.models.auto_release_group import ( AutoReleaseGroup as AutoReleaseGroup, @@ -919,6 +944,7 @@ ) from koyeb.api_async.models.grpc_health_check import GRPCHealthCheck as GRPCHealthCheck from koyeb.api_async.models.get_app_reply import GetAppReply as GetAppReply +from koyeb.api_async.models.get_archive_reply import GetArchiveReply as GetArchiveReply from koyeb.api_async.models.get_budget_reply import GetBudgetReply as GetBudgetReply from koyeb.api_async.models.get_catalog_instance_reply import ( GetCatalogInstanceReply as GetCatalogInstanceReply, @@ -1101,6 +1127,9 @@ from koyeb.api_async.models.kgitproxy_repository_provider import ( KgitproxyRepositoryProvider as KgitproxyRepositoryProvider, ) +from koyeb.api_async.models.kmeta_get_organization_workspace_quotas_reply import ( + KmetaGetOrganizationWorkspaceQuotasReply as KmetaGetOrganizationWorkspaceQuotasReply, +) from koyeb.api_async.models.ksearch_app import KsearchApp as KsearchApp from koyeb.api_async.models.ksearch_global_deployment import ( KsearchGlobalDeployment as KsearchGlobalDeployment, @@ -1128,6 +1157,9 @@ ListAppEventsReply as ListAppEventsReply, ) from koyeb.api_async.models.list_apps_reply import ListAppsReply as ListAppsReply +from koyeb.api_async.models.list_archives_reply import ( + ListArchivesReply as ListArchivesReply, +) from koyeb.api_async.models.list_catalog_instances_reply import ( ListCatalogInstancesReply as ListCatalogInstancesReply, ) @@ -1347,6 +1379,21 @@ from koyeb.api_async.models.query_logs_reply_pagination import ( QueryLogsReplyPagination as QueryLogsReplyPagination, ) +from koyeb.api_async.models.query_services_view_filters import ( + QueryServicesViewFilters as QueryServicesViewFilters, +) +from koyeb.api_async.models.query_services_view_reply import ( + QueryServicesViewReply as QueryServicesViewReply, +) +from koyeb.api_async.models.query_services_view_sort import ( + QueryServicesViewSort as QueryServicesViewSort, +) +from koyeb.api_async.models.query_services_view_sort_direction import ( + QueryServicesViewSortDirection as QueryServicesViewSortDirection, +) +from koyeb.api_async.models.query_services_view_sort_field import ( + QueryServicesViewSortField as QueryServicesViewSortField, +) from koyeb.api_async.models.quota_usage import QuotaUsage as QuotaUsage from koyeb.api_async.models.quotas import Quotas as Quotas from koyeb.api_async.models.reactivate_organization_reply import ( @@ -1441,6 +1488,41 @@ from koyeb.api_async.models.service_summary import ServiceSummary as ServiceSummary from koyeb.api_async.models.service_type import ServiceType as ServiceType from koyeb.api_async.models.service_usage import ServiceUsage as ServiceUsage +from koyeb.api_async.models.service_view_active_deployment import ( + ServiceViewActiveDeployment as ServiceViewActiveDeployment, +) +from koyeb.api_async.models.service_view_active_deployment_state import ( + ServiceViewActiveDeploymentState as ServiceViewActiveDeploymentState, +) +from koyeb.api_async.models.service_view_app import ServiceViewApp as ServiceViewApp +from koyeb.api_async.models.service_view_facet import ( + ServiceViewFacet as ServiceViewFacet, +) +from koyeb.api_async.models.service_view_facet_kind import ( + ServiceViewFacetKind as ServiceViewFacetKind, +) +from koyeb.api_async.models.service_view_facet_value import ( + ServiceViewFacetValue as ServiceViewFacetValue, +) +from koyeb.api_async.models.service_view_group import ( + ServiceViewGroup as ServiceViewGroup, +) +from koyeb.api_async.models.service_view_group_by import ( + ServiceViewGroupBy as ServiceViewGroupBy, +) +from koyeb.api_async.models.service_view_latest_deployment import ( + ServiceViewLatestDeployment as ServiceViewLatestDeployment, +) +from koyeb.api_async.models.service_view_latest_deployment_state import ( + ServiceViewLatestDeploymentState as ServiceViewLatestDeploymentState, +) +from koyeb.api_async.models.service_view_row import ServiceViewRow as ServiceViewRow +from koyeb.api_async.models.service_view_source import ( + ServiceViewSource as ServiceViewSource, +) +from koyeb.api_async.models.service_view_source_type import ( + ServiceViewSourceType as ServiceViewSourceType, +) from koyeb.api_async.models.snapshot import Snapshot as Snapshot from koyeb.api_async.models.snapshot_status import SnapshotStatus as SnapshotStatus from koyeb.api_async.models.snapshot_type import SnapshotType as SnapshotType diff --git a/koyeb/api_async/api/__init__.py b/koyeb/api_async/api/__init__.py index fce7b4ac..f9c22a7e 100644 --- a/koyeb/api_async/api/__init__.py +++ b/koyeb/api_async/api/__init__.py @@ -36,6 +36,7 @@ from koyeb.api_async.api.search_api import SearchApi from koyeb.api_async.api.secrets_api import SecretsApi from koyeb.api_async.api.service_pools_api import ServicePoolsApi +from koyeb.api_async.api.service_views_api import ServiceViewsApi from koyeb.api_async.api.services_api import ServicesApi from koyeb.api_async.api.sessions_api import SessionsApi from koyeb.api_async.api.snapshots_api import SnapshotsApi diff --git a/koyeb/api_async/api/activity_api.py b/koyeb/api_async/api/activity_api.py index 86587ac6..fae55096 100644 --- a/koyeb/api_async/api/activity_api.py +++ b/koyeb/api_async/api/activity_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/api/apps_api.py b/koyeb/api_async/api/apps_api.py index 4e54129f..012eac66 100644 --- a/koyeb/api_async/api/apps_api.py +++ b/koyeb/api_async/api/apps_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/api/archives_api.py b/koyeb/api_async/api/archives_api.py index f598e931..b8cd4164 100644 --- a/koyeb/api_async/api/archives_api.py +++ b/koyeb/api_async/api/archives_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -15,8 +15,13 @@ from typing import Any, Dict, List, Optional, Tuple, Union from typing_extensions import Annotated +from pydantic import Field, StrictStr, field_validator +from typing import Any, Dict, List, Optional +from typing_extensions import Annotated from koyeb.api_async.models.create_archive import CreateArchive from koyeb.api_async.models.create_archive_reply import CreateArchiveReply +from koyeb.api_async.models.get_archive_reply import GetArchiveReply +from koyeb.api_async.models.list_archives_reply import ListArchivesReply from koyeb.api_async.api_client import ApiClient, RequestSerialized from koyeb.api_async.api_response import ApiResponse @@ -294,3 +299,877 @@ def _create_archive_serialize( _host=_host, _request_auth=_request_auth, ) + + @validate_call + async def delete_archive( + self, + id: Annotated[StrictStr, Field(description="The id of the archive.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> object: + """Delete Archive + + Mark an archive for deletion. Its status becomes deleting, and it is deleted along with its file shortly after. Deployments already built from it keep running, but nothing can be built from it any more. + + :param id: The id of the archive. (required) + :type id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_archive_serialize( + id=id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "object", + "400": "ErrorWithFields", + "401": "Error", + "403": "Error", + "404": "Error", + "500": "Error", + "503": "Error", + "default": "GoogleRpcStatus", + } + response_data = await self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + await response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + @validate_call + async def delete_archive_with_http_info( + self, + id: Annotated[StrictStr, Field(description="The id of the archive.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[object]: + """Delete Archive + + Mark an archive for deletion. Its status becomes deleting, and it is deleted along with its file shortly after. Deployments already built from it keep running, but nothing can be built from it any more. + + :param id: The id of the archive. (required) + :type id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_archive_serialize( + id=id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "object", + "400": "ErrorWithFields", + "401": "Error", + "403": "Error", + "404": "Error", + "500": "Error", + "503": "Error", + "default": "GoogleRpcStatus", + } + response_data = await self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + await response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + @validate_call + async def delete_archive_without_preload_content( + self, + id: Annotated[StrictStr, Field(description="The id of the archive.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete Archive + + Mark an archive for deletion. Its status becomes deleting, and it is deleted along with its file shortly after. Deployments already built from it keep running, but nothing can be built from it any more. + + :param id: The id of the archive. (required) + :type id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_archive_serialize( + id=id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "object", + "400": "ErrorWithFields", + "401": "Error", + "403": "Error", + "404": "Error", + "500": "Error", + "503": "Error", + "default": "GoogleRpcStatus", + } + response_data = await self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + return response_data.response + + def _delete_archive_serialize( + self, + id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + _host = None + + _collection_formats: Dict[str, str] = {} + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Any] = self.api_client._merge_headers(_headers) + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params["id"] = id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + # set the HTTP header `Accept` + if not any(key.lower() == "accept" for key in _header_params): + _header_params["Accept"] = self.api_client.select_header_accept(["*/*"]) + + # authentication setting + _auth_settings: List[str] = ["Bearer"] + + return self.api_client.param_serialize( + method="DELETE", + resource_path="/v1/archives/{id}", + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth, + ) + + @validate_call + async def get_archive( + self, + id: Annotated[StrictStr, Field(description="The id of the archive.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> GetArchiveReply: + """Get Archive + + Get an archive, with a signed URL to download it. + + :param id: The id of the archive. (required) + :type id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_archive_serialize( + id=id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "GetArchiveReply", + "400": "ErrorWithFields", + "401": "Error", + "403": "Error", + "404": "Error", + "500": "Error", + "503": "Error", + "default": "GoogleRpcStatus", + } + response_data = await self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + await response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + @validate_call + async def get_archive_with_http_info( + self, + id: Annotated[StrictStr, Field(description="The id of the archive.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[GetArchiveReply]: + """Get Archive + + Get an archive, with a signed URL to download it. + + :param id: The id of the archive. (required) + :type id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_archive_serialize( + id=id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "GetArchiveReply", + "400": "ErrorWithFields", + "401": "Error", + "403": "Error", + "404": "Error", + "500": "Error", + "503": "Error", + "default": "GoogleRpcStatus", + } + response_data = await self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + await response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + @validate_call + async def get_archive_without_preload_content( + self, + id: Annotated[StrictStr, Field(description="The id of the archive.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Archive + + Get an archive, with a signed URL to download it. + + :param id: The id of the archive. (required) + :type id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_archive_serialize( + id=id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "GetArchiveReply", + "400": "ErrorWithFields", + "401": "Error", + "403": "Error", + "404": "Error", + "500": "Error", + "503": "Error", + "default": "GoogleRpcStatus", + } + response_data = await self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + return response_data.response + + def _get_archive_serialize( + self, + id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + _host = None + + _collection_formats: Dict[str, str] = {} + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Any] = self.api_client._merge_headers(_headers) + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params["id"] = id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + # set the HTTP header `Accept` + if not any(key.lower() == "accept" for key in _header_params): + _header_params["Accept"] = self.api_client.select_header_accept(["*/*"]) + + # authentication setting + _auth_settings: List[str] = ["Bearer"] + + return self.api_client.param_serialize( + method="GET", + resource_path="/v1/archives/{id}", + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth, + ) + + @validate_call + async def list_archives( + self, + limit: Annotated[ + Optional[StrictStr], + Field(description="(Optional) The number of items to return"), + ] = None, + offset: Annotated[ + Optional[StrictStr], + Field(description="(Optional) The offset in the list of items to return"), + ] = None, + ids: Annotated[ + Optional[List[StrictStr]], + Field(description="(Optional) Filter on archive ids"), + ] = None, + statuses: Annotated[ + Optional[List[StrictStr]], + Field( + description="(Optional) Filter by archive status - ARCHIVE_STATUS_INVALID: zero value, invalid - ARCHIVE_STATUS_HEALTHY: the archive can be deployed and downloaded - ARCHIVE_STATUS_DELETING: the archive is waiting for its file to be removed - ARCHIVE_STATUS_DELETED: the archive and its file are deleted" + ), + ] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ListArchivesReply: + """List Archives + + List the archives of the organization, most recent first. + + :param limit: (Optional) The number of items to return + :type limit: str + :param offset: (Optional) The offset in the list of items to return + :type offset: str + :param ids: (Optional) Filter on archive ids + :type ids: List[str] + :param statuses: (Optional) Filter by archive status - ARCHIVE_STATUS_INVALID: zero value, invalid - ARCHIVE_STATUS_HEALTHY: the archive can be deployed and downloaded - ARCHIVE_STATUS_DELETING: the archive is waiting for its file to be removed - ARCHIVE_STATUS_DELETED: the archive and its file are deleted + :type statuses: List[str] + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_archives_serialize( + limit=limit, + offset=offset, + ids=ids, + statuses=statuses, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "ListArchivesReply", + "400": "ErrorWithFields", + "401": "Error", + "403": "Error", + "404": "Error", + "500": "Error", + "503": "Error", + "default": "GoogleRpcStatus", + } + response_data = await self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + await response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + @validate_call + async def list_archives_with_http_info( + self, + limit: Annotated[ + Optional[StrictStr], + Field(description="(Optional) The number of items to return"), + ] = None, + offset: Annotated[ + Optional[StrictStr], + Field(description="(Optional) The offset in the list of items to return"), + ] = None, + ids: Annotated[ + Optional[List[StrictStr]], + Field(description="(Optional) Filter on archive ids"), + ] = None, + statuses: Annotated[ + Optional[List[StrictStr]], + Field( + description="(Optional) Filter by archive status - ARCHIVE_STATUS_INVALID: zero value, invalid - ARCHIVE_STATUS_HEALTHY: the archive can be deployed and downloaded - ARCHIVE_STATUS_DELETING: the archive is waiting for its file to be removed - ARCHIVE_STATUS_DELETED: the archive and its file are deleted" + ), + ] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ListArchivesReply]: + """List Archives + + List the archives of the organization, most recent first. + + :param limit: (Optional) The number of items to return + :type limit: str + :param offset: (Optional) The offset in the list of items to return + :type offset: str + :param ids: (Optional) Filter on archive ids + :type ids: List[str] + :param statuses: (Optional) Filter by archive status - ARCHIVE_STATUS_INVALID: zero value, invalid - ARCHIVE_STATUS_HEALTHY: the archive can be deployed and downloaded - ARCHIVE_STATUS_DELETING: the archive is waiting for its file to be removed - ARCHIVE_STATUS_DELETED: the archive and its file are deleted + :type statuses: List[str] + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_archives_serialize( + limit=limit, + offset=offset, + ids=ids, + statuses=statuses, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "ListArchivesReply", + "400": "ErrorWithFields", + "401": "Error", + "403": "Error", + "404": "Error", + "500": "Error", + "503": "Error", + "default": "GoogleRpcStatus", + } + response_data = await self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + await response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + @validate_call + async def list_archives_without_preload_content( + self, + limit: Annotated[ + Optional[StrictStr], + Field(description="(Optional) The number of items to return"), + ] = None, + offset: Annotated[ + Optional[StrictStr], + Field(description="(Optional) The offset in the list of items to return"), + ] = None, + ids: Annotated[ + Optional[List[StrictStr]], + Field(description="(Optional) Filter on archive ids"), + ] = None, + statuses: Annotated[ + Optional[List[StrictStr]], + Field( + description="(Optional) Filter by archive status - ARCHIVE_STATUS_INVALID: zero value, invalid - ARCHIVE_STATUS_HEALTHY: the archive can be deployed and downloaded - ARCHIVE_STATUS_DELETING: the archive is waiting for its file to be removed - ARCHIVE_STATUS_DELETED: the archive and its file are deleted" + ), + ] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """List Archives + + List the archives of the organization, most recent first. + + :param limit: (Optional) The number of items to return + :type limit: str + :param offset: (Optional) The offset in the list of items to return + :type offset: str + :param ids: (Optional) Filter on archive ids + :type ids: List[str] + :param statuses: (Optional) Filter by archive status - ARCHIVE_STATUS_INVALID: zero value, invalid - ARCHIVE_STATUS_HEALTHY: the archive can be deployed and downloaded - ARCHIVE_STATUS_DELETING: the archive is waiting for its file to be removed - ARCHIVE_STATUS_DELETED: the archive and its file are deleted + :type statuses: List[str] + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_archives_serialize( + limit=limit, + offset=offset, + ids=ids, + statuses=statuses, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "ListArchivesReply", + "400": "ErrorWithFields", + "401": "Error", + "403": "Error", + "404": "Error", + "500": "Error", + "503": "Error", + "default": "GoogleRpcStatus", + } + response_data = await self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + return response_data.response + + def _list_archives_serialize( + self, + limit, + offset, + ids, + statuses, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + _host = None + + _collection_formats: Dict[str, str] = { + "ids": "multi", + "statuses": "multi", + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Any] = self.api_client._merge_headers(_headers) + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if limit is not None: + _query_params.append(("limit", limit)) + + if offset is not None: + _query_params.append(("offset", offset)) + + if ids is not None: + _query_params.append(("ids", ids)) + + if statuses is not None: + _query_params.append(("statuses", statuses)) + + # process the header parameters + # process the form parameters + # process the body parameter + + # set the HTTP header `Accept` + if not any(key.lower() == "accept" for key in _header_params): + _header_params["Accept"] = self.api_client.select_header_accept(["*/*"]) + + # authentication setting + _auth_settings: List[str] = ["Bearer"] + + return self.api_client.param_serialize( + method="GET", + resource_path="/v1/archives", + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth, + ) diff --git a/koyeb/api_async/api/billing_api.py b/koyeb/api_async/api/billing_api.py index b071550e..297199b8 100644 --- a/koyeb/api_async/api/billing_api.py +++ b/koyeb/api_async/api/billing_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/api/catalog_datacenters_api.py b/koyeb/api_async/api/catalog_datacenters_api.py index 57e05612..e693c865 100644 --- a/koyeb/api_async/api/catalog_datacenters_api.py +++ b/koyeb/api_async/api/catalog_datacenters_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/api/catalog_instance_usage_api.py b/koyeb/api_async/api/catalog_instance_usage_api.py index 61891861..4676ad00 100644 --- a/koyeb/api_async/api/catalog_instance_usage_api.py +++ b/koyeb/api_async/api/catalog_instance_usage_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/api/catalog_instances_api.py b/koyeb/api_async/api/catalog_instances_api.py index 12077d34..9ab6b713 100644 --- a/koyeb/api_async/api/catalog_instances_api.py +++ b/koyeb/api_async/api/catalog_instances_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/api/catalog_regions_api.py b/koyeb/api_async/api/catalog_regions_api.py index e9239e06..6e5eef23 100644 --- a/koyeb/api_async/api/catalog_regions_api.py +++ b/koyeb/api_async/api/catalog_regions_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/api/compose_api.py b/koyeb/api_async/api/compose_api.py index 30aa0e73..15dc7741 100644 --- a/koyeb/api_async/api/compose_api.py +++ b/koyeb/api_async/api/compose_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/api/coupons_api.py b/koyeb/api_async/api/coupons_api.py index beaab322..fb95537a 100644 --- a/koyeb/api_async/api/coupons_api.py +++ b/koyeb/api_async/api/coupons_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/api/credentials_api.py b/koyeb/api_async/api/credentials_api.py index 07c8b90e..8975d8aa 100644 --- a/koyeb/api_async/api/credentials_api.py +++ b/koyeb/api_async/api/credentials_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/api/deployments_api.py b/koyeb/api_async/api/deployments_api.py index ca5a2aa2..7cf0a234 100644 --- a/koyeb/api_async/api/deployments_api.py +++ b/koyeb/api_async/api/deployments_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/api/docker_helper_api.py b/koyeb/api_async/api/docker_helper_api.py index 60fbde99..b79b49c4 100644 --- a/koyeb/api_async/api/docker_helper_api.py +++ b/koyeb/api_async/api/docker_helper_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/api/domains_api.py b/koyeb/api_async/api/domains_api.py index 80e56ded..59a2526a 100644 --- a/koyeb/api_async/api/domains_api.py +++ b/koyeb/api_async/api/domains_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/api/instance_snapshots_api.py b/koyeb/api_async/api/instance_snapshots_api.py index 8719b103..3aeba793 100644 --- a/koyeb/api_async/api/instance_snapshots_api.py +++ b/koyeb/api_async/api/instance_snapshots_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/api/instances_api.py b/koyeb/api_async/api/instances_api.py index a36b2b7e..7150aa1c 100644 --- a/koyeb/api_async/api/instances_api.py +++ b/koyeb/api_async/api/instances_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/api/intercom_api.py b/koyeb/api_async/api/intercom_api.py index a71ea925..36f50fe5 100644 --- a/koyeb/api_async/api/intercom_api.py +++ b/koyeb/api_async/api/intercom_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/api/invite_api.py b/koyeb/api_async/api/invite_api.py index ad4a4416..4141865c 100644 --- a/koyeb/api_async/api/invite_api.py +++ b/koyeb/api_async/api/invite_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/api/logs_api.py b/koyeb/api_async/api/logs_api.py index 2cfc0bf7..413911fd 100644 --- a/koyeb/api_async/api/logs_api.py +++ b/koyeb/api_async/api/logs_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/api/metrics_api.py b/koyeb/api_async/api/metrics_api.py index b5baf1b5..e32f0932 100644 --- a/koyeb/api_async/api/metrics_api.py +++ b/koyeb/api_async/api/metrics_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/api/organization_api.py b/koyeb/api_async/api/organization_api.py index dca828ed..397b996e 100644 --- a/koyeb/api_async/api/organization_api.py +++ b/koyeb/api_async/api/organization_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/api/organization_confirmations_api.py b/koyeb/api_async/api/organization_confirmations_api.py index d091b74e..0a58578f 100644 --- a/koyeb/api_async/api/organization_confirmations_api.py +++ b/koyeb/api_async/api/organization_confirmations_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/api/organization_invitations_api.py b/koyeb/api_async/api/organization_invitations_api.py index d7064e10..0e1bdfdd 100644 --- a/koyeb/api_async/api/organization_invitations_api.py +++ b/koyeb/api_async/api/organization_invitations_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/api/organization_members_api.py b/koyeb/api_async/api/organization_members_api.py index b5602176..403d1e15 100644 --- a/koyeb/api_async/api/organization_members_api.py +++ b/koyeb/api_async/api/organization_members_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/api/organization_quotas_api.py b/koyeb/api_async/api/organization_quotas_api.py index 188bac25..eb41bc55 100644 --- a/koyeb/api_async/api/organization_quotas_api.py +++ b/koyeb/api_async/api/organization_quotas_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/api/payment_methods_api.py b/koyeb/api_async/api/payment_methods_api.py index 406029bd..469905e4 100644 --- a/koyeb/api_async/api/payment_methods_api.py +++ b/koyeb/api_async/api/payment_methods_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/api/persistent_volumes_api.py b/koyeb/api_async/api/persistent_volumes_api.py index 88303db2..f663d6cf 100644 --- a/koyeb/api_async/api/persistent_volumes_api.py +++ b/koyeb/api_async/api/persistent_volumes_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/api/pool_claims_api.py b/koyeb/api_async/api/pool_claims_api.py index f8074f8f..3bd97c3c 100644 --- a/koyeb/api_async/api/pool_claims_api.py +++ b/koyeb/api_async/api/pool_claims_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/api/profile_api.py b/koyeb/api_async/api/profile_api.py index d87d82db..9f840473 100644 --- a/koyeb/api_async/api/profile_api.py +++ b/koyeb/api_async/api/profile_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/api/projects_api.py b/koyeb/api_async/api/projects_api.py index 537b9704..e8dd942b 100644 --- a/koyeb/api_async/api/projects_api.py +++ b/koyeb/api_async/api/projects_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/api/provisioning_api.py b/koyeb/api_async/api/provisioning_api.py index 823ad2d7..98733377 100644 --- a/koyeb/api_async/api/provisioning_api.py +++ b/koyeb/api_async/api/provisioning_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/api/quotas_api.py b/koyeb/api_async/api/quotas_api.py index fc596fea..2346a3ab 100644 --- a/koyeb/api_async/api/quotas_api.py +++ b/koyeb/api_async/api/quotas_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -19,6 +19,9 @@ from koyeb.api_async.models.get_organization_quotas_usage_reply import ( GetOrganizationQuotasUsageReply, ) +from koyeb.api_async.models.kmeta_get_organization_workspace_quotas_reply import ( + KmetaGetOrganizationWorkspaceQuotasReply, +) from koyeb.api_async.models.review_organization_capacity_reply import ( ReviewOrganizationCapacityReply, ) @@ -300,6 +303,260 @@ def _get_organization_quotas_usage_serialize( _request_auth=_request_auth, ) + @validate_call + async def get_organization_workspace_quotas( + self, + organization_id: StrictStr, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> KmetaGetOrganizationWorkspaceQuotasReply: + """get_organization_workspace_quotas + + + :param organization_id: (required) + :type organization_id: str + :param workspace_id: (required) + :type workspace_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_organization_workspace_quotas_serialize( + organization_id=organization_id, + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "KmetaGetOrganizationWorkspaceQuotasReply", + "default": "GoogleRpcStatus", + } + response_data = await self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + await response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + @validate_call + async def get_organization_workspace_quotas_with_http_info( + self, + organization_id: StrictStr, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[KmetaGetOrganizationWorkspaceQuotasReply]: + """get_organization_workspace_quotas + + + :param organization_id: (required) + :type organization_id: str + :param workspace_id: (required) + :type workspace_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_organization_workspace_quotas_serialize( + organization_id=organization_id, + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "KmetaGetOrganizationWorkspaceQuotasReply", + "default": "GoogleRpcStatus", + } + response_data = await self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + await response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + @validate_call + async def get_organization_workspace_quotas_without_preload_content( + self, + organization_id: StrictStr, + workspace_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """get_organization_workspace_quotas + + + :param organization_id: (required) + :type organization_id: str + :param workspace_id: (required) + :type workspace_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_organization_workspace_quotas_serialize( + organization_id=organization_id, + workspace_id=workspace_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "KmetaGetOrganizationWorkspaceQuotasReply", + "default": "GoogleRpcStatus", + } + response_data = await self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + return response_data.response + + def _get_organization_workspace_quotas_serialize( + self, + organization_id, + workspace_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + _host = None + + _collection_formats: Dict[str, str] = {} + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Any] = self.api_client._merge_headers(_headers) + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if organization_id is not None: + _path_params["organization_id"] = organization_id + if workspace_id is not None: + _path_params["workspace_id"] = workspace_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + # set the HTTP header `Accept` + if not any(key.lower() == "accept" for key in _header_params): + _header_params["Accept"] = self.api_client.select_header_accept(["*/*"]) + + # authentication setting + _auth_settings: List[str] = ["Bearer"] + + return self.api_client.param_serialize( + method="GET", + resource_path="/v1/quotas/organizations/{organization_id}/{workspace_id}/quotas", + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth, + ) + @validate_call async def review_organization_capacity( self, diff --git a/koyeb/api_async/api/regional_deployments_api.py b/koyeb/api_async/api/regional_deployments_api.py index a45b5b2c..6af98a77 100644 --- a/koyeb/api_async/api/regional_deployments_api.py +++ b/koyeb/api_async/api/regional_deployments_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/api/repositories_api.py b/koyeb/api_async/api/repositories_api.py index 6447546b..f9c74421 100644 --- a/koyeb/api_async/api/repositories_api.py +++ b/koyeb/api_async/api/repositories_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/api/search_api.py b/koyeb/api_async/api/search_api.py index 97a62068..5424cd03 100644 --- a/koyeb/api_async/api/search_api.py +++ b/koyeb/api_async/api/search_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/api/secrets_api.py b/koyeb/api_async/api/secrets_api.py index 07d6b169..807653b8 100644 --- a/koyeb/api_async/api/secrets_api.py +++ b/koyeb/api_async/api/secrets_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/api/service_pools_api.py b/koyeb/api_async/api/service_pools_api.py index 0e4f60f9..5ccb966f 100644 --- a/koyeb/api_async/api/service_pools_api.py +++ b/koyeb/api_async/api/service_pools_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -15,8 +15,9 @@ from typing import Any, Dict, List, Optional, Tuple, Union from typing_extensions import Annotated -from pydantic import StrictStr +from pydantic import Field, StrictStr from typing import Any, Dict, Optional +from typing_extensions import Annotated from koyeb.api_async.models.create_service_pool import CreateServicePool from koyeb.api_async.models.create_service_pool_reply import CreateServicePoolReply from koyeb.api_async.models.get_service_pool_reply import GetServicePoolReply @@ -818,7 +819,12 @@ async def list_service_pools( name: Optional[StrictStr] = None, limit: Optional[StrictStr] = None, offset: Optional[StrictStr] = None, - status: Optional[StrictStr] = None, + status: Annotated[ + Optional[StrictStr], + Field( + description="Filter pools by their own status: ready, provisioning, error or deleting." + ), + ] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -900,7 +906,12 @@ async def list_service_pools_with_http_info( name: Optional[StrictStr] = None, limit: Optional[StrictStr] = None, offset: Optional[StrictStr] = None, - status: Optional[StrictStr] = None, + status: Annotated[ + Optional[StrictStr], + Field( + description="Filter pools by their own status: ready, provisioning, error or deleting." + ), + ] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -982,7 +993,12 @@ async def list_service_pools_without_preload_content( name: Optional[StrictStr] = None, limit: Optional[StrictStr] = None, offset: Optional[StrictStr] = None, - status: Optional[StrictStr] = None, + status: Annotated[ + Optional[StrictStr], + Field( + description="Filter pools by their own status: ready, provisioning, error or deleting." + ), + ] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], diff --git a/koyeb/api_async/api/service_views_api.py b/koyeb/api_async/api/service_views_api.py new file mode 100644 index 00000000..26006fc8 --- /dev/null +++ b/koyeb/api_async/api/service_views_api.py @@ -0,0 +1,642 @@ +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictBool, StrictStr, field_validator +from typing import List, Optional +from typing_extensions import Annotated +from koyeb.api_async.models.query_services_view_reply import QueryServicesViewReply + +from koyeb.api_async.api_client import ApiClient, RequestSerialized +from koyeb.api_async.api_response import ApiResponse +from koyeb.api_async.rest import RESTResponseType + + +class ServiceViewsApi: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + @validate_call + async def query_services_view( + self, + search: Annotated[ + Optional[StrictStr], + Field( + description="(Optional) Case-insensitive search on the Service name and the App name" + ), + ] = None, + filters_types: Annotated[ + Optional[List[StrictStr]], + Field(description="(Optional) Filter on Service types"), + ] = None, + filters_statuses: Annotated[ + Optional[List[StrictStr]], + Field(description="(Optional) Filter on Service statuses"), + ] = None, + filters_regions: Annotated[ + Optional[List[StrictStr]], + Field(description="(Optional) Filter on regions of the latest Deployment"), + ] = None, + filters_app_ids: Annotated[ + Optional[List[StrictStr]], Field(description="(Optional) Filter on App ids") + ] = None, + filters_active_deployment_states: Annotated[ + Optional[List[StrictStr]], + Field( + description="(Optional) Filter on active Deployment states - SLEEPING: The active Deployment is scaled to zero and wakes up on traffic" + ), + ] = None, + filters_latest_deployment_states: Annotated[ + Optional[List[StrictStr]], + Field(description="(Optional) Filter on latest Deployment states"), + ] = None, + filters_needs_attention: Annotated[ + Optional[StrictBool], + Field(description="(Optional) Filter on Services that need attention"), + ] = None, + sort_field: Optional[StrictStr] = None, + sort_direction: Optional[StrictStr] = None, + group_by: Annotated[ + Optional[StrictStr], + Field( + description="(Optional) Group rows by App. Groups are ordered by App name and keep a stable order across pages. Pagination always counts Services" + ), + ] = None, + limit: Annotated[ + Optional[StrictStr], + Field(description="(Optional) The number of items to return"), + ] = None, + offset: Annotated[ + Optional[StrictStr], + Field(description="(Optional) The offset in the list of item to return"), + ] = None, + facets: Annotated[ + Optional[List[StrictStr]], + Field(description="(Optional) Facets to compute on the full result"), + ] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> QueryServicesViewReply: + """Query the Services view + + Unstable: this endpoint may change without notice. Returns Services with their App and Deployment state. Filters, search, sorting, grouping, counts and facets are all computed on the full authorized result before pagination. + + :param search: (Optional) Case-insensitive search on the Service name and the App name + :type search: str + :param filters_types: (Optional) Filter on Service types + :type filters_types: List[str] + :param filters_statuses: (Optional) Filter on Service statuses + :type filters_statuses: List[str] + :param filters_regions: (Optional) Filter on regions of the latest Deployment + :type filters_regions: List[str] + :param filters_app_ids: (Optional) Filter on App ids + :type filters_app_ids: List[str] + :param filters_active_deployment_states: (Optional) Filter on active Deployment states - SLEEPING: The active Deployment is scaled to zero and wakes up on traffic + :type filters_active_deployment_states: List[str] + :param filters_latest_deployment_states: (Optional) Filter on latest Deployment states + :type filters_latest_deployment_states: List[str] + :param filters_needs_attention: (Optional) Filter on Services that need attention + :type filters_needs_attention: bool + :param sort_field: + :type sort_field: str + :param sort_direction: + :type sort_direction: str + :param group_by: (Optional) Group rows by App. Groups are ordered by App name and keep a stable order across pages. Pagination always counts Services + :type group_by: str + :param limit: (Optional) The number of items to return + :type limit: str + :param offset: (Optional) The offset in the list of item to return + :type offset: str + :param facets: (Optional) Facets to compute on the full result + :type facets: List[str] + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._query_services_view_serialize( + search=search, + filters_types=filters_types, + filters_statuses=filters_statuses, + filters_regions=filters_regions, + filters_app_ids=filters_app_ids, + filters_active_deployment_states=filters_active_deployment_states, + filters_latest_deployment_states=filters_latest_deployment_states, + filters_needs_attention=filters_needs_attention, + sort_field=sort_field, + sort_direction=sort_direction, + group_by=group_by, + limit=limit, + offset=offset, + facets=facets, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "QueryServicesViewReply", + "400": "ErrorWithFields", + "401": "Error", + "403": "Error", + "404": "Error", + "500": "Error", + "503": "Error", + "default": "GoogleRpcStatus", + } + response_data = await self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + await response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + @validate_call + async def query_services_view_with_http_info( + self, + search: Annotated[ + Optional[StrictStr], + Field( + description="(Optional) Case-insensitive search on the Service name and the App name" + ), + ] = None, + filters_types: Annotated[ + Optional[List[StrictStr]], + Field(description="(Optional) Filter on Service types"), + ] = None, + filters_statuses: Annotated[ + Optional[List[StrictStr]], + Field(description="(Optional) Filter on Service statuses"), + ] = None, + filters_regions: Annotated[ + Optional[List[StrictStr]], + Field(description="(Optional) Filter on regions of the latest Deployment"), + ] = None, + filters_app_ids: Annotated[ + Optional[List[StrictStr]], Field(description="(Optional) Filter on App ids") + ] = None, + filters_active_deployment_states: Annotated[ + Optional[List[StrictStr]], + Field( + description="(Optional) Filter on active Deployment states - SLEEPING: The active Deployment is scaled to zero and wakes up on traffic" + ), + ] = None, + filters_latest_deployment_states: Annotated[ + Optional[List[StrictStr]], + Field(description="(Optional) Filter on latest Deployment states"), + ] = None, + filters_needs_attention: Annotated[ + Optional[StrictBool], + Field(description="(Optional) Filter on Services that need attention"), + ] = None, + sort_field: Optional[StrictStr] = None, + sort_direction: Optional[StrictStr] = None, + group_by: Annotated[ + Optional[StrictStr], + Field( + description="(Optional) Group rows by App. Groups are ordered by App name and keep a stable order across pages. Pagination always counts Services" + ), + ] = None, + limit: Annotated[ + Optional[StrictStr], + Field(description="(Optional) The number of items to return"), + ] = None, + offset: Annotated[ + Optional[StrictStr], + Field(description="(Optional) The offset in the list of item to return"), + ] = None, + facets: Annotated[ + Optional[List[StrictStr]], + Field(description="(Optional) Facets to compute on the full result"), + ] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[QueryServicesViewReply]: + """Query the Services view + + Unstable: this endpoint may change without notice. Returns Services with their App and Deployment state. Filters, search, sorting, grouping, counts and facets are all computed on the full authorized result before pagination. + + :param search: (Optional) Case-insensitive search on the Service name and the App name + :type search: str + :param filters_types: (Optional) Filter on Service types + :type filters_types: List[str] + :param filters_statuses: (Optional) Filter on Service statuses + :type filters_statuses: List[str] + :param filters_regions: (Optional) Filter on regions of the latest Deployment + :type filters_regions: List[str] + :param filters_app_ids: (Optional) Filter on App ids + :type filters_app_ids: List[str] + :param filters_active_deployment_states: (Optional) Filter on active Deployment states - SLEEPING: The active Deployment is scaled to zero and wakes up on traffic + :type filters_active_deployment_states: List[str] + :param filters_latest_deployment_states: (Optional) Filter on latest Deployment states + :type filters_latest_deployment_states: List[str] + :param filters_needs_attention: (Optional) Filter on Services that need attention + :type filters_needs_attention: bool + :param sort_field: + :type sort_field: str + :param sort_direction: + :type sort_direction: str + :param group_by: (Optional) Group rows by App. Groups are ordered by App name and keep a stable order across pages. Pagination always counts Services + :type group_by: str + :param limit: (Optional) The number of items to return + :type limit: str + :param offset: (Optional) The offset in the list of item to return + :type offset: str + :param facets: (Optional) Facets to compute on the full result + :type facets: List[str] + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._query_services_view_serialize( + search=search, + filters_types=filters_types, + filters_statuses=filters_statuses, + filters_regions=filters_regions, + filters_app_ids=filters_app_ids, + filters_active_deployment_states=filters_active_deployment_states, + filters_latest_deployment_states=filters_latest_deployment_states, + filters_needs_attention=filters_needs_attention, + sort_field=sort_field, + sort_direction=sort_direction, + group_by=group_by, + limit=limit, + offset=offset, + facets=facets, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "QueryServicesViewReply", + "400": "ErrorWithFields", + "401": "Error", + "403": "Error", + "404": "Error", + "500": "Error", + "503": "Error", + "default": "GoogleRpcStatus", + } + response_data = await self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + await response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + @validate_call + async def query_services_view_without_preload_content( + self, + search: Annotated[ + Optional[StrictStr], + Field( + description="(Optional) Case-insensitive search on the Service name and the App name" + ), + ] = None, + filters_types: Annotated[ + Optional[List[StrictStr]], + Field(description="(Optional) Filter on Service types"), + ] = None, + filters_statuses: Annotated[ + Optional[List[StrictStr]], + Field(description="(Optional) Filter on Service statuses"), + ] = None, + filters_regions: Annotated[ + Optional[List[StrictStr]], + Field(description="(Optional) Filter on regions of the latest Deployment"), + ] = None, + filters_app_ids: Annotated[ + Optional[List[StrictStr]], Field(description="(Optional) Filter on App ids") + ] = None, + filters_active_deployment_states: Annotated[ + Optional[List[StrictStr]], + Field( + description="(Optional) Filter on active Deployment states - SLEEPING: The active Deployment is scaled to zero and wakes up on traffic" + ), + ] = None, + filters_latest_deployment_states: Annotated[ + Optional[List[StrictStr]], + Field(description="(Optional) Filter on latest Deployment states"), + ] = None, + filters_needs_attention: Annotated[ + Optional[StrictBool], + Field(description="(Optional) Filter on Services that need attention"), + ] = None, + sort_field: Optional[StrictStr] = None, + sort_direction: Optional[StrictStr] = None, + group_by: Annotated[ + Optional[StrictStr], + Field( + description="(Optional) Group rows by App. Groups are ordered by App name and keep a stable order across pages. Pagination always counts Services" + ), + ] = None, + limit: Annotated[ + Optional[StrictStr], + Field(description="(Optional) The number of items to return"), + ] = None, + offset: Annotated[ + Optional[StrictStr], + Field(description="(Optional) The offset in the list of item to return"), + ] = None, + facets: Annotated[ + Optional[List[StrictStr]], + Field(description="(Optional) Facets to compute on the full result"), + ] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Query the Services view + + Unstable: this endpoint may change without notice. Returns Services with their App and Deployment state. Filters, search, sorting, grouping, counts and facets are all computed on the full authorized result before pagination. + + :param search: (Optional) Case-insensitive search on the Service name and the App name + :type search: str + :param filters_types: (Optional) Filter on Service types + :type filters_types: List[str] + :param filters_statuses: (Optional) Filter on Service statuses + :type filters_statuses: List[str] + :param filters_regions: (Optional) Filter on regions of the latest Deployment + :type filters_regions: List[str] + :param filters_app_ids: (Optional) Filter on App ids + :type filters_app_ids: List[str] + :param filters_active_deployment_states: (Optional) Filter on active Deployment states - SLEEPING: The active Deployment is scaled to zero and wakes up on traffic + :type filters_active_deployment_states: List[str] + :param filters_latest_deployment_states: (Optional) Filter on latest Deployment states + :type filters_latest_deployment_states: List[str] + :param filters_needs_attention: (Optional) Filter on Services that need attention + :type filters_needs_attention: bool + :param sort_field: + :type sort_field: str + :param sort_direction: + :type sort_direction: str + :param group_by: (Optional) Group rows by App. Groups are ordered by App name and keep a stable order across pages. Pagination always counts Services + :type group_by: str + :param limit: (Optional) The number of items to return + :type limit: str + :param offset: (Optional) The offset in the list of item to return + :type offset: str + :param facets: (Optional) Facets to compute on the full result + :type facets: List[str] + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._query_services_view_serialize( + search=search, + filters_types=filters_types, + filters_statuses=filters_statuses, + filters_regions=filters_regions, + filters_app_ids=filters_app_ids, + filters_active_deployment_states=filters_active_deployment_states, + filters_latest_deployment_states=filters_latest_deployment_states, + filters_needs_attention=filters_needs_attention, + sort_field=sort_field, + sort_direction=sort_direction, + group_by=group_by, + limit=limit, + offset=offset, + facets=facets, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "QueryServicesViewReply", + "400": "ErrorWithFields", + "401": "Error", + "403": "Error", + "404": "Error", + "500": "Error", + "503": "Error", + "default": "GoogleRpcStatus", + } + response_data = await self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + return response_data.response + + def _query_services_view_serialize( + self, + search, + filters_types, + filters_statuses, + filters_regions, + filters_app_ids, + filters_active_deployment_states, + filters_latest_deployment_states, + filters_needs_attention, + sort_field, + sort_direction, + group_by, + limit, + offset, + facets, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + _host = None + + _collection_formats: Dict[str, str] = { + "filters.types": "multi", + "filters.statuses": "multi", + "filters.regions": "multi", + "filters.app_ids": "multi", + "filters.active_deployment_states": "multi", + "filters.latest_deployment_states": "multi", + "facets": "multi", + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Any] = self.api_client._merge_headers(_headers) + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if search is not None: + _query_params.append(("search", search)) + + if filters_types is not None: + _query_params.append(("filters.types", filters_types)) + + if filters_statuses is not None: + _query_params.append(("filters.statuses", filters_statuses)) + + if filters_regions is not None: + _query_params.append(("filters.regions", filters_regions)) + + if filters_app_ids is not None: + _query_params.append(("filters.app_ids", filters_app_ids)) + + if filters_active_deployment_states is not None: + _query_params.append( + ("filters.active_deployment_states", filters_active_deployment_states) + ) + + if filters_latest_deployment_states is not None: + _query_params.append( + ("filters.latest_deployment_states", filters_latest_deployment_states) + ) + + if filters_needs_attention is not None: + _query_params.append(("filters.needs_attention", filters_needs_attention)) + + if sort_field is not None: + _query_params.append(("sort.field", sort_field)) + + if sort_direction is not None: + _query_params.append(("sort.direction", sort_direction)) + + if group_by is not None: + _query_params.append(("group_by", group_by)) + + if limit is not None: + _query_params.append(("limit", limit)) + + if offset is not None: + _query_params.append(("offset", offset)) + + if facets is not None: + _query_params.append(("facets", facets)) + + # process the header parameters + # process the form parameters + # process the body parameter + + # set the HTTP header `Accept` + if not any(key.lower() == "accept" for key in _header_params): + _header_params["Accept"] = self.api_client.select_header_accept(["*/*"]) + + # authentication setting + _auth_settings: List[str] = ["Bearer"] + + return self.api_client.param_serialize( + method="GET", + resource_path="/v1/views/services", + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth, + ) diff --git a/koyeb/api_async/api/services_api.py b/koyeb/api_async/api/services_api.py index dcfc3373..491af6a3 100644 --- a/koyeb/api_async/api/services_api.py +++ b/koyeb/api_async/api/services_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/api/sessions_api.py b/koyeb/api_async/api/sessions_api.py index 7181f770..2316ae91 100644 --- a/koyeb/api_async/api/sessions_api.py +++ b/koyeb/api_async/api/sessions_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/api/snapshots_api.py b/koyeb/api_async/api/snapshots_api.py index 3edf8db4..2eaa800f 100644 --- a/koyeb/api_async/api/snapshots_api.py +++ b/koyeb/api_async/api/snapshots_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -832,7 +832,7 @@ async def list_snapshots( statuses: Annotated[ Optional[List[StrictStr]], Field( - description="(Optional) Filter by status - SNAPSHOT_STATUS_INVALID: zero value, invalid - SNAPSHOT_STATUS_CREATING: the snapshot is being created - SNAPSHOT_STATUS_AVAILABLE: the snapshot is complete and available - SNAPSHOT_STATUS_MIGRATING: the snapshot is being migrated - SNAPSHOT_STATUS_DELETING: the snapshot is being deleted - SNAPSHOT_STATUS_DELETED: the snapshot is deleted" + description="(Optional) Filter by status - SNAPSHOT_STATUS_INVALID: zero value, invalid - SNAPSHOT_STATUS_CREATING: the snapshot is being created - SNAPSHOT_STATUS_AVAILABLE: the snapshot is complete and available - SNAPSHOT_STATUS_MIGRATING: the snapshot is being migrated - SNAPSHOT_STATUS_DELETING: the snapshot is being deleted - SNAPSHOT_STATUS_DELETED: the snapshot is deleted - SNAPSHOT_STATUS_ERROR: the snapshot could not be created" ), ] = None, region: Annotated[ @@ -863,7 +863,7 @@ async def list_snapshots( :type offset: str :param organization_id: (Optional) Filter by organization_id :type organization_id: str - :param statuses: (Optional) Filter by status - SNAPSHOT_STATUS_INVALID: zero value, invalid - SNAPSHOT_STATUS_CREATING: the snapshot is being created - SNAPSHOT_STATUS_AVAILABLE: the snapshot is complete and available - SNAPSHOT_STATUS_MIGRATING: the snapshot is being migrated - SNAPSHOT_STATUS_DELETING: the snapshot is being deleted - SNAPSHOT_STATUS_DELETED: the snapshot is deleted + :param statuses: (Optional) Filter by status - SNAPSHOT_STATUS_INVALID: zero value, invalid - SNAPSHOT_STATUS_CREATING: the snapshot is being created - SNAPSHOT_STATUS_AVAILABLE: the snapshot is complete and available - SNAPSHOT_STATUS_MIGRATING: the snapshot is being migrated - SNAPSHOT_STATUS_DELETING: the snapshot is being deleted - SNAPSHOT_STATUS_DELETED: the snapshot is deleted - SNAPSHOT_STATUS_ERROR: the snapshot could not be created :type statuses: List[str] :param region: (Optional) A filter for the region :type region: str @@ -941,7 +941,7 @@ async def list_snapshots_with_http_info( statuses: Annotated[ Optional[List[StrictStr]], Field( - description="(Optional) Filter by status - SNAPSHOT_STATUS_INVALID: zero value, invalid - SNAPSHOT_STATUS_CREATING: the snapshot is being created - SNAPSHOT_STATUS_AVAILABLE: the snapshot is complete and available - SNAPSHOT_STATUS_MIGRATING: the snapshot is being migrated - SNAPSHOT_STATUS_DELETING: the snapshot is being deleted - SNAPSHOT_STATUS_DELETED: the snapshot is deleted" + description="(Optional) Filter by status - SNAPSHOT_STATUS_INVALID: zero value, invalid - SNAPSHOT_STATUS_CREATING: the snapshot is being created - SNAPSHOT_STATUS_AVAILABLE: the snapshot is complete and available - SNAPSHOT_STATUS_MIGRATING: the snapshot is being migrated - SNAPSHOT_STATUS_DELETING: the snapshot is being deleted - SNAPSHOT_STATUS_DELETED: the snapshot is deleted - SNAPSHOT_STATUS_ERROR: the snapshot could not be created" ), ] = None, region: Annotated[ @@ -972,7 +972,7 @@ async def list_snapshots_with_http_info( :type offset: str :param organization_id: (Optional) Filter by organization_id :type organization_id: str - :param statuses: (Optional) Filter by status - SNAPSHOT_STATUS_INVALID: zero value, invalid - SNAPSHOT_STATUS_CREATING: the snapshot is being created - SNAPSHOT_STATUS_AVAILABLE: the snapshot is complete and available - SNAPSHOT_STATUS_MIGRATING: the snapshot is being migrated - SNAPSHOT_STATUS_DELETING: the snapshot is being deleted - SNAPSHOT_STATUS_DELETED: the snapshot is deleted + :param statuses: (Optional) Filter by status - SNAPSHOT_STATUS_INVALID: zero value, invalid - SNAPSHOT_STATUS_CREATING: the snapshot is being created - SNAPSHOT_STATUS_AVAILABLE: the snapshot is complete and available - SNAPSHOT_STATUS_MIGRATING: the snapshot is being migrated - SNAPSHOT_STATUS_DELETING: the snapshot is being deleted - SNAPSHOT_STATUS_DELETED: the snapshot is deleted - SNAPSHOT_STATUS_ERROR: the snapshot could not be created :type statuses: List[str] :param region: (Optional) A filter for the region :type region: str @@ -1050,7 +1050,7 @@ async def list_snapshots_without_preload_content( statuses: Annotated[ Optional[List[StrictStr]], Field( - description="(Optional) Filter by status - SNAPSHOT_STATUS_INVALID: zero value, invalid - SNAPSHOT_STATUS_CREATING: the snapshot is being created - SNAPSHOT_STATUS_AVAILABLE: the snapshot is complete and available - SNAPSHOT_STATUS_MIGRATING: the snapshot is being migrated - SNAPSHOT_STATUS_DELETING: the snapshot is being deleted - SNAPSHOT_STATUS_DELETED: the snapshot is deleted" + description="(Optional) Filter by status - SNAPSHOT_STATUS_INVALID: zero value, invalid - SNAPSHOT_STATUS_CREATING: the snapshot is being created - SNAPSHOT_STATUS_AVAILABLE: the snapshot is complete and available - SNAPSHOT_STATUS_MIGRATING: the snapshot is being migrated - SNAPSHOT_STATUS_DELETING: the snapshot is being deleted - SNAPSHOT_STATUS_DELETED: the snapshot is deleted - SNAPSHOT_STATUS_ERROR: the snapshot could not be created" ), ] = None, region: Annotated[ @@ -1081,7 +1081,7 @@ async def list_snapshots_without_preload_content( :type offset: str :param organization_id: (Optional) Filter by organization_id :type organization_id: str - :param statuses: (Optional) Filter by status - SNAPSHOT_STATUS_INVALID: zero value, invalid - SNAPSHOT_STATUS_CREATING: the snapshot is being created - SNAPSHOT_STATUS_AVAILABLE: the snapshot is complete and available - SNAPSHOT_STATUS_MIGRATING: the snapshot is being migrated - SNAPSHOT_STATUS_DELETING: the snapshot is being deleted - SNAPSHOT_STATUS_DELETED: the snapshot is deleted + :param statuses: (Optional) Filter by status - SNAPSHOT_STATUS_INVALID: zero value, invalid - SNAPSHOT_STATUS_CREATING: the snapshot is being created - SNAPSHOT_STATUS_AVAILABLE: the snapshot is complete and available - SNAPSHOT_STATUS_MIGRATING: the snapshot is being migrated - SNAPSHOT_STATUS_DELETING: the snapshot is being deleted - SNAPSHOT_STATUS_DELETED: the snapshot is deleted - SNAPSHOT_STATUS_ERROR: the snapshot could not be created :type statuses: List[str] :param region: (Optional) A filter for the region :type region: str diff --git a/koyeb/api_async/api/sso_api.py b/koyeb/api_async/api/sso_api.py index 172415cb..1acf7831 100644 --- a/koyeb/api_async/api/sso_api.py +++ b/koyeb/api_async/api/sso_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/api/subscriptions_api.py b/koyeb/api_async/api/subscriptions_api.py index 9c956797..4f15f1c7 100644 --- a/koyeb/api_async/api/subscriptions_api.py +++ b/koyeb/api_async/api/subscriptions_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/api/summary_api.py b/koyeb/api_async/api/summary_api.py index 8c2b860a..755bbdde 100644 --- a/koyeb/api_async/api/summary_api.py +++ b/koyeb/api_async/api/summary_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/api/test_api.py b/koyeb/api_async/api/test_api.py index 4aebe1bb..e6a8d02b 100644 --- a/koyeb/api_async/api/test_api.py +++ b/koyeb/api_async/api/test_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/api/usages_api.py b/koyeb/api_async/api/usages_api.py index 95fc8964..5beeb0aa 100644 --- a/koyeb/api_async/api/usages_api.py +++ b/koyeb/api_async/api/usages_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/api/users_api.py b/koyeb/api_async/api/users_api.py index a734e748..3afa5e38 100644 --- a/koyeb/api_async/api/users_api.py +++ b/koyeb/api_async/api/users_api.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/api_client.py b/koyeb/api_async/api_client.py index f93c903a..c2c524e4 100644 --- a/koyeb/api_async/api_client.py +++ b/koyeb/api_async/api_client.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -87,7 +87,7 @@ def __init__( self.default_headers[header_name] = header_value self.cookie = cookie # Set default User-Agent. - self.user_agent = "OpenAPI-Generator/1.6.1/python" + self.user_agent = "OpenAPI-Generator/1.6.2/python" self.client_side_validation = configuration.client_side_validation async def __aenter__(self): diff --git a/koyeb/api_async/configuration.py b/koyeb/api_async/configuration.py index d32dda8d..472379db 100644 --- a/koyeb/api_async/configuration.py +++ b/koyeb/api_async/configuration.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -567,7 +567,7 @@ def to_debug_report(self) -> str: "OS: {env}\n" "Python Version: {pyversion}\n" "Version of the API: 1.0.0\n" - "SDK Package Version: 1.6.1".format(env=sys.platform, pyversion=sys.version) + "SDK Package Version: 1.6.2".format(env=sys.platform, pyversion=sys.version) ) def get_host_settings(self) -> List[HostSetting]: diff --git a/koyeb/api_async/docs/AppLifeCycle.md b/koyeb/api_async/docs/AppLifeCycle.md index d93df67d..66d9ad37 100644 --- a/koyeb/api_async/docs/AppLifeCycle.md +++ b/koyeb/api_async/docs/AppLifeCycle.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**delete_when_empty** | **bool** | | [optional] +**delete_when_empty** | **bool** | If true, the app is deleted once it has no service left: either when its last service is deleted or, for an app that never had a service, once it is older than 15 minutes. | [optional] ## Example diff --git a/koyeb/api_async/docs/Archive.md b/koyeb/api_async/docs/Archive.md index f4b65a3d..b7d70a54 100644 --- a/koyeb/api_async/docs/Archive.md +++ b/koyeb/api_async/docs/Archive.md @@ -11,6 +11,9 @@ Name | Type | Description | Notes **size** | **str** | The provisioned space for the archive. | [optional] **created_at** | **datetime** | Date of creation of the archive. | [optional] **deleted_at** | **datetime** | This field is automatically set by Koyeb when the archive is garbage collected. | [optional] +**download_url** | **str** | A signed URL to download the archive. Getting an archive signs a new one when it has less than 5 minutes left, valid for 24 hours. | [optional] +**download_url_deadline** | **datetime** | When download_url expires. | [optional] +**status** | [**ArchiveStatus**](ArchiveStatus.md) | | [optional] [default to ArchiveStatus.ARCHIVE_STATUS_INVALID] ## Example diff --git a/koyeb/api_async/docs/ArchiveStatus.md b/koyeb/api_async/docs/ArchiveStatus.md new file mode 100644 index 00000000..c07a3405 --- /dev/null +++ b/koyeb/api_async/docs/ArchiveStatus.md @@ -0,0 +1,16 @@ +# ArchiveStatus + + +## Enum + +* `ARCHIVE_STATUS_INVALID` (value: `'ARCHIVE_STATUS_INVALID'`) + +* `ARCHIVE_STATUS_HEALTHY` (value: `'ARCHIVE_STATUS_HEALTHY'`) + +* `ARCHIVE_STATUS_DELETING` (value: `'ARCHIVE_STATUS_DELETING'`) + +* `ARCHIVE_STATUS_DELETED` (value: `'ARCHIVE_STATUS_DELETED'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/koyeb/api_async/docs/ArchivesApi.md b/koyeb/api_async/docs/ArchivesApi.md index bcf7c6ed..b74fafa2 100644 --- a/koyeb/api_async/docs/ArchivesApi.md +++ b/koyeb/api_async/docs/ArchivesApi.md @@ -5,6 +5,9 @@ All URIs are relative to *https://app.koyeb.com* Method | HTTP request | Description ------------- | ------------- | ------------- [**create_archive**](ArchivesApi.md#create_archive) | **POST** /v1/archives | Create Archive +[**delete_archive**](ArchivesApi.md#delete_archive) | **DELETE** /v1/archives/{id} | Delete Archive +[**get_archive**](ArchivesApi.md#get_archive) | **GET** /v1/archives/{id} | Get Archive +[**list_archives**](ArchivesApi.md#list_archives) | **GET** /v1/archives | List Archives # **create_archive** @@ -94,3 +97,268 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **delete_archive** +> object delete_archive(id) + +Delete Archive + +Mark an archive for deletion. Its status becomes deleting, and it is +deleted along with its file shortly after. Deployments already built from +it keep running, but nothing can be built from it any more. + +### Example + +* Api Key Authentication (Bearer): + +```python +import koyeb.api_async +from koyeb.api_async.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://app.koyeb.com +# See configuration.py for a list of all supported configuration parameters. +configuration = koyeb.api_async.Configuration( + host = "https://app.koyeb.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: Bearer +configuration.api_key['Bearer'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Bearer'] = 'Bearer' + +# Enter a context with an instance of the API client +async with koyeb.api_async.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = koyeb.api_async.ArchivesApi(api_client) + id = 'id_example' # str | The id of the archive. + + try: + # Delete Archive + api_response = await api_instance.delete_archive(id) + print("The response of ArchivesApi->delete_archive:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ArchivesApi->delete_archive: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| The id of the archive. | + +### Return type + +**object** + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | A successful response. | - | +**400** | Validation error | - | +**401** | Returned when the token is not valid. | - | +**403** | Returned when the user does not have permission to access the resource. | - | +**404** | Returned when the resource does not exist. | - | +**500** | Returned in case of server error. | - | +**503** | Service is unavailable. | - | +**0** | An unexpected error response. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_archive** +> GetArchiveReply get_archive(id) + +Get Archive + +Get an archive, with a signed URL to download it. + +### Example + +* Api Key Authentication (Bearer): + +```python +import koyeb.api_async +from koyeb.api_async.models.get_archive_reply import GetArchiveReply +from koyeb.api_async.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://app.koyeb.com +# See configuration.py for a list of all supported configuration parameters. +configuration = koyeb.api_async.Configuration( + host = "https://app.koyeb.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: Bearer +configuration.api_key['Bearer'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Bearer'] = 'Bearer' + +# Enter a context with an instance of the API client +async with koyeb.api_async.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = koyeb.api_async.ArchivesApi(api_client) + id = 'id_example' # str | The id of the archive. + + try: + # Get Archive + api_response = await api_instance.get_archive(id) + print("The response of ArchivesApi->get_archive:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ArchivesApi->get_archive: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| The id of the archive. | + +### Return type + +[**GetArchiveReply**](GetArchiveReply.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | A successful response. | - | +**400** | Validation error | - | +**401** | Returned when the token is not valid. | - | +**403** | Returned when the user does not have permission to access the resource. | - | +**404** | Returned when the resource does not exist. | - | +**500** | Returned in case of server error. | - | +**503** | Service is unavailable. | - | +**0** | An unexpected error response. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **list_archives** +> ListArchivesReply list_archives(limit=limit, offset=offset, ids=ids, statuses=statuses) + +List Archives + +List the archives of the organization, most recent first. + +### Example + +* Api Key Authentication (Bearer): + +```python +import koyeb.api_async +from koyeb.api_async.models.list_archives_reply import ListArchivesReply +from koyeb.api_async.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://app.koyeb.com +# See configuration.py for a list of all supported configuration parameters. +configuration = koyeb.api_async.Configuration( + host = "https://app.koyeb.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: Bearer +configuration.api_key['Bearer'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Bearer'] = 'Bearer' + +# Enter a context with an instance of the API client +async with koyeb.api_async.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = koyeb.api_async.ArchivesApi(api_client) + limit = 'limit_example' # str | (Optional) The number of items to return (optional) + offset = 'offset_example' # str | (Optional) The offset in the list of items to return (optional) + ids = ['ids_example'] # List[str] | (Optional) Filter on archive ids (optional) + statuses = ['statuses_example'] # List[str] | (Optional) Filter by archive status - ARCHIVE_STATUS_INVALID: zero value, invalid - ARCHIVE_STATUS_HEALTHY: the archive can be deployed and downloaded - ARCHIVE_STATUS_DELETING: the archive is waiting for its file to be removed - ARCHIVE_STATUS_DELETED: the archive and its file are deleted (optional) + + try: + # List Archives + api_response = await api_instance.list_archives(limit=limit, offset=offset, ids=ids, statuses=statuses) + print("The response of ArchivesApi->list_archives:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ArchivesApi->list_archives: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **limit** | **str**| (Optional) The number of items to return | [optional] + **offset** | **str**| (Optional) The offset in the list of items to return | [optional] + **ids** | [**List[str]**](str.md)| (Optional) Filter on archive ids | [optional] + **statuses** | [**List[str]**](str.md)| (Optional) Filter by archive status - ARCHIVE_STATUS_INVALID: zero value, invalid - ARCHIVE_STATUS_HEALTHY: the archive can be deployed and downloaded - ARCHIVE_STATUS_DELETING: the archive is waiting for its file to be removed - ARCHIVE_STATUS_DELETED: the archive and its file are deleted | [optional] + +### Return type + +[**ListArchivesReply**](ListArchivesReply.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | A successful response. | - | +**400** | Validation error | - | +**401** | Returned when the token is not valid. | - | +**403** | Returned when the user does not have permission to access the resource. | - | +**404** | Returned when the resource does not exist. | - | +**500** | Returned in case of server error. | - | +**503** | Service is unavailable. | - | +**0** | An unexpected error response. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/koyeb/api_async/docs/DeploymentDefinition.md b/koyeb/api_async/docs/DeploymentDefinition.md index 6351b37c..44a0dad5 100644 --- a/koyeb/api_async/docs/DeploymentDefinition.md +++ b/koyeb/api_async/docs/DeploymentDefinition.md @@ -21,6 +21,7 @@ Name | Type | Description | Notes **skip_cache** | **bool** | | [optional] **mesh** | [**DeploymentMesh**](DeploymentMesh.md) | | [optional] [default to DeploymentMesh.DEPLOYMENT_MESH_AUTO] **network_policy** | [**NetworkPolicy**](NetworkPolicy.md) | | [optional] +**kill_timeout_secs** | **int** | | [optional] **docker** | [**DockerSource**](DockerSource.md) | | [optional] **git** | [**GitSource**](GitSource.md) | | [optional] **database** | [**DatabaseSource**](DatabaseSource.md) | | [optional] diff --git a/koyeb/api_async/docs/GetArchiveReply.md b/koyeb/api_async/docs/GetArchiveReply.md new file mode 100644 index 00000000..1ceee848 --- /dev/null +++ b/koyeb/api_async/docs/GetArchiveReply.md @@ -0,0 +1,29 @@ +# GetArchiveReply + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**archive** | [**Archive**](Archive.md) | | [optional] + +## Example + +```python +from koyeb.api_async.models.get_archive_reply import GetArchiveReply + +# TODO update the JSON string below +json = "{}" +# create an instance of GetArchiveReply from a JSON string +get_archive_reply_instance = GetArchiveReply.from_json(json) +# print the JSON string representation of the object +print(GetArchiveReply.to_json()) + +# convert the object into a dict +get_archive_reply_dict = get_archive_reply_instance.to_dict() +# create an instance of GetArchiveReply from a dict +get_archive_reply_from_dict = GetArchiveReply.from_dict(get_archive_reply_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/koyeb/api_async/docs/GitSource.md b/koyeb/api_async/docs/GitSource.md index 1a01491e..7845410b 100644 --- a/koyeb/api_async/docs/GitSource.md +++ b/koyeb/api_async/docs/GitSource.md @@ -16,6 +16,7 @@ Name | Type | Description | Notes **buildpack** | [**BuildpackBuilder**](BuildpackBuilder.md) | | [optional] **docker** | [**DockerBuilder**](DockerBuilder.md) | | [optional] **credential_source** | **str** | Credentials can come from a specific source or default to using Github (when unset or set to \"github\"). | [optional] +**skip_submodules** | **bool** | A flag to skip initializing git submodules when cloning the repository. | [optional] ## Example diff --git a/koyeb/api_async/docs/KmetaGetOrganizationWorkspaceQuotasReply.md b/koyeb/api_async/docs/KmetaGetOrganizationWorkspaceQuotasReply.md new file mode 100644 index 00000000..0c79ecc4 --- /dev/null +++ b/koyeb/api_async/docs/KmetaGetOrganizationWorkspaceQuotasReply.md @@ -0,0 +1,29 @@ +# KmetaGetOrganizationWorkspaceQuotasReply + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**quotas** | [**Quotas**](Quotas.md) | | [optional] + +## Example + +```python +from koyeb.api_async.models.kmeta_get_organization_workspace_quotas_reply import KmetaGetOrganizationWorkspaceQuotasReply + +# TODO update the JSON string below +json = "{}" +# create an instance of KmetaGetOrganizationWorkspaceQuotasReply from a JSON string +kmeta_get_organization_workspace_quotas_reply_instance = KmetaGetOrganizationWorkspaceQuotasReply.from_json(json) +# print the JSON string representation of the object +print(KmetaGetOrganizationWorkspaceQuotasReply.to_json()) + +# convert the object into a dict +kmeta_get_organization_workspace_quotas_reply_dict = kmeta_get_organization_workspace_quotas_reply_instance.to_dict() +# create an instance of KmetaGetOrganizationWorkspaceQuotasReply from a dict +kmeta_get_organization_workspace_quotas_reply_from_dict = KmetaGetOrganizationWorkspaceQuotasReply.from_dict(kmeta_get_organization_workspace_quotas_reply_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/koyeb/api_async/docs/ListArchivesReply.md b/koyeb/api_async/docs/ListArchivesReply.md new file mode 100644 index 00000000..b9ed5aaa --- /dev/null +++ b/koyeb/api_async/docs/ListArchivesReply.md @@ -0,0 +1,33 @@ +# ListArchivesReply + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**archives** | [**List[Archive]**](Archive.md) | | [optional] +**limit** | **int** | | [optional] +**offset** | **int** | | [optional] +**count** | **int** | | [optional] +**has_next** | **bool** | | [optional] + +## Example + +```python +from koyeb.api_async.models.list_archives_reply import ListArchivesReply + +# TODO update the JSON string below +json = "{}" +# create an instance of ListArchivesReply from a JSON string +list_archives_reply_instance = ListArchivesReply.from_json(json) +# print the JSON string representation of the object +print(ListArchivesReply.to_json()) + +# convert the object into a dict +list_archives_reply_dict = list_archives_reply_instance.to_dict() +# create an instance of ListArchivesReply from a dict +list_archives_reply_from_dict = ListArchivesReply.from_dict(list_archives_reply_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/koyeb/api_async/docs/PoolClaim.md b/koyeb/api_async/docs/PoolClaim.md index d988a341..51d68502 100644 --- a/koyeb/api_async/docs/PoolClaim.md +++ b/koyeb/api_async/docs/PoolClaim.md @@ -12,10 +12,8 @@ Name | Type | Description | Notes **status** | [**PoolClaimStatus**](PoolClaimStatus.md) | | [optional] [default to PoolClaimStatus.UNSPECIFIED] **organization_id** | **str** | | [optional] **workspace_id** | **str** | | [optional] -**customer_id** | **str** | | [optional] **created_at** | **datetime** | | [optional] **fulfilled_at** | **datetime** | | [optional] -**released_at** | **datetime** | | [optional] **pool_generation** | **str** | | [optional] ## Example diff --git a/koyeb/api_async/docs/PoolClaimRequest.md b/koyeb/api_async/docs/PoolClaimRequest.md index 55b7db07..5b219742 100644 --- a/koyeb/api_async/docs/PoolClaimRequest.md +++ b/koyeb/api_async/docs/PoolClaimRequest.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pool_id** | **str** | | [optional] -**request_id** | **str** | | [optional] +**request_id** | **str** | Idempotency key scoped to the pool: retries with the same value return the same claim. A fresh id is generated when omitted. | [optional] ## Example diff --git a/koyeb/api_async/docs/PoolClaimStatus.md b/koyeb/api_async/docs/PoolClaimStatus.md index 0fd605aa..cc826a4e 100644 --- a/koyeb/api_async/docs/PoolClaimStatus.md +++ b/koyeb/api_async/docs/PoolClaimStatus.md @@ -11,8 +11,6 @@ * `FAILED` (value: `'FAILED'`) -* `RELEASED` (value: `'RELEASED'`) - [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/koyeb/api_async/docs/QueryServicesViewFilters.md b/koyeb/api_async/docs/QueryServicesViewFilters.md new file mode 100644 index 00000000..41c1407c --- /dev/null +++ b/koyeb/api_async/docs/QueryServicesViewFilters.md @@ -0,0 +1,35 @@ +# QueryServicesViewFilters + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**types** | [**List[ServiceType]**](ServiceType.md) | | [optional] +**statuses** | [**List[ServiceStatus]**](ServiceStatus.md) | | [optional] +**regions** | **List[str]** | | [optional] +**app_ids** | **List[str]** | | [optional] +**active_deployment_states** | [**List[ServiceViewActiveDeploymentState]**](ServiceViewActiveDeploymentState.md) | | [optional] +**latest_deployment_states** | [**List[ServiceViewLatestDeploymentState]**](ServiceViewLatestDeploymentState.md) | | [optional] +**needs_attention** | **bool** | | [optional] + +## Example + +```python +from koyeb.api_async.models.query_services_view_filters import QueryServicesViewFilters + +# TODO update the JSON string below +json = "{}" +# create an instance of QueryServicesViewFilters from a JSON string +query_services_view_filters_instance = QueryServicesViewFilters.from_json(json) +# print the JSON string representation of the object +print(QueryServicesViewFilters.to_json()) + +# convert the object into a dict +query_services_view_filters_dict = query_services_view_filters_instance.to_dict() +# create an instance of QueryServicesViewFilters from a dict +query_services_view_filters_from_dict = QueryServicesViewFilters.from_dict(query_services_view_filters_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/koyeb/api_async/docs/QueryServicesViewReply.md b/koyeb/api_async/docs/QueryServicesViewReply.md new file mode 100644 index 00000000..dcf8b46c --- /dev/null +++ b/koyeb/api_async/docs/QueryServicesViewReply.md @@ -0,0 +1,35 @@ +# QueryServicesViewReply + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**services** | [**List[ServiceViewRow]**](ServiceViewRow.md) | | [optional] +**groups** | [**List[ServiceViewGroup]**](ServiceViewGroup.md) | | [optional] +**facets** | [**List[ServiceViewFacet]**](ServiceViewFacet.md) | | [optional] +**limit** | **int** | | [optional] +**offset** | **int** | | [optional] +**count** | **int** | | [optional] +**has_next** | **bool** | | [optional] + +## Example + +```python +from koyeb.api_async.models.query_services_view_reply import QueryServicesViewReply + +# TODO update the JSON string below +json = "{}" +# create an instance of QueryServicesViewReply from a JSON string +query_services_view_reply_instance = QueryServicesViewReply.from_json(json) +# print the JSON string representation of the object +print(QueryServicesViewReply.to_json()) + +# convert the object into a dict +query_services_view_reply_dict = query_services_view_reply_instance.to_dict() +# create an instance of QueryServicesViewReply from a dict +query_services_view_reply_from_dict = QueryServicesViewReply.from_dict(query_services_view_reply_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/koyeb/api_async/docs/QueryServicesViewSort.md b/koyeb/api_async/docs/QueryServicesViewSort.md new file mode 100644 index 00000000..34c11674 --- /dev/null +++ b/koyeb/api_async/docs/QueryServicesViewSort.md @@ -0,0 +1,30 @@ +# QueryServicesViewSort + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_field** | [**QueryServicesViewSortField**](QueryServicesViewSortField.md) | | [optional] [default to QueryServicesViewSortField.CREATED_AT] +**direction** | [**QueryServicesViewSortDirection**](QueryServicesViewSortDirection.md) | | [optional] [default to QueryServicesViewSortDirection.ASC] + +## Example + +```python +from koyeb.api_async.models.query_services_view_sort import QueryServicesViewSort + +# TODO update the JSON string below +json = "{}" +# create an instance of QueryServicesViewSort from a JSON string +query_services_view_sort_instance = QueryServicesViewSort.from_json(json) +# print the JSON string representation of the object +print(QueryServicesViewSort.to_json()) + +# convert the object into a dict +query_services_view_sort_dict = query_services_view_sort_instance.to_dict() +# create an instance of QueryServicesViewSort from a dict +query_services_view_sort_from_dict = QueryServicesViewSort.from_dict(query_services_view_sort_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/koyeb/api_async/docs/QueryServicesViewSortDirection.md b/koyeb/api_async/docs/QueryServicesViewSortDirection.md new file mode 100644 index 00000000..4907e5f1 --- /dev/null +++ b/koyeb/api_async/docs/QueryServicesViewSortDirection.md @@ -0,0 +1,12 @@ +# QueryServicesViewSortDirection + + +## Enum + +* `ASC` (value: `'ASC'`) + +* `DESC` (value: `'DESC'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/koyeb/api_async/docs/QueryServicesViewSortField.md b/koyeb/api_async/docs/QueryServicesViewSortField.md new file mode 100644 index 00000000..24fec507 --- /dev/null +++ b/koyeb/api_async/docs/QueryServicesViewSortField.md @@ -0,0 +1,20 @@ +# QueryServicesViewSortField + + +## Enum + +* `CREATED_AT` (value: `'CREATED_AT'`) + +* `UPDATED_AT` (value: `'UPDATED_AT'`) + +* `NAME` (value: `'NAME'`) + +* `APP_NAME` (value: `'APP_NAME'`) + +* `ACTIVE_DEPLOYMENT_STATE` (value: `'ACTIVE_DEPLOYMENT_STATE'`) + +* `LATEST_DEPLOYMENT_STATE` (value: `'LATEST_DEPLOYMENT_STATE'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/koyeb/api_async/docs/Quotas.md b/koyeb/api_async/docs/Quotas.md index a0b03b02..53a7b125 100644 --- a/koyeb/api_async/docs/Quotas.md +++ b/koyeb/api_async/docs/Quotas.md @@ -27,6 +27,7 @@ Name | Type | Description | Notes **lifecycle** | [**LifecycleQuotas**](LifecycleQuotas.md) | | [optional] **max_projects** | **str** | | [optional] **instance_snapshots** | [**InstanceSnapshotQuotas**](InstanceSnapshotQuotas.md) | | [optional] +**persistent_volumes_disabled** | **bool** | When true, persistent volumes are disabled for the organization regardless of persistent_volumes_by_region. kaccount's ComputeQuotas omits persistent_volumes_by_region when this is set, so the flag must travel explicitly — otherwise consumers cannot distinguish \"disabled\" from \"no custom quotas\". | [optional] ## Example diff --git a/koyeb/api_async/docs/QuotasApi.md b/koyeb/api_async/docs/QuotasApi.md index 088775c2..e639cdfc 100644 --- a/koyeb/api_async/docs/QuotasApi.md +++ b/koyeb/api_async/docs/QuotasApi.md @@ -5,6 +5,7 @@ All URIs are relative to *https://app.koyeb.com* Method | HTTP request | Description ------------- | ------------- | ------------- [**get_organization_quotas_usage**](QuotasApi.md#get_organization_quotas_usage) | **GET** /v1/quotas/organizations/{organization_id}/usage | Return the organization's current quota usage alongside the plan's limits. Response is cached in Redis for 60s. Accept text/plain (or ?format=prometheus) to receive the response rendered as Prometheus text exposition format (\"koyeb_quota_<x>\" for usage, \"koyeb_quota_<x>_limit\" for the plan limit) suitable for scraping into an external Prometheus. +[**get_organization_workspace_quotas**](QuotasApi.md#get_organization_workspace_quotas) | **GET** /v1/quotas/organizations/{organization_id}/{workspace_id}/quotas | [**review_organization_capacity**](QuotasApi.md#review_organization_capacity) | **POST** /v1/quotas/capacity | DEPRECATED: Review Organization Capacity @@ -92,6 +93,83 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **get_organization_workspace_quotas** +> KmetaGetOrganizationWorkspaceQuotasReply get_organization_workspace_quotas(organization_id, workspace_id) + +### Example + +* Api Key Authentication (Bearer): + +```python +import koyeb.api_async +from koyeb.api_async.models.kmeta_get_organization_workspace_quotas_reply import KmetaGetOrganizationWorkspaceQuotasReply +from koyeb.api_async.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://app.koyeb.com +# See configuration.py for a list of all supported configuration parameters. +configuration = koyeb.api_async.Configuration( + host = "https://app.koyeb.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: Bearer +configuration.api_key['Bearer'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Bearer'] = 'Bearer' + +# Enter a context with an instance of the API client +async with koyeb.api_async.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = koyeb.api_async.QuotasApi(api_client) + organization_id = 'organization_id_example' # str | + workspace_id = 'workspace_id_example' # str | + + try: + api_response = await api_instance.get_organization_workspace_quotas(organization_id, workspace_id) + print("The response of QuotasApi->get_organization_workspace_quotas:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling QuotasApi->get_organization_workspace_quotas: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_id** | **str**| | + **workspace_id** | **str**| | + +### Return type + +[**KmetaGetOrganizationWorkspaceQuotasReply**](KmetaGetOrganizationWorkspaceQuotasReply.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | A successful response. | - | +**0** | An unexpected error response. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **review_organization_capacity** > ReviewOrganizationCapacityReply review_organization_capacity(body) diff --git a/koyeb/api_async/docs/RegionalDeploymentDefinition.md b/koyeb/api_async/docs/RegionalDeploymentDefinition.md index b1cda1ab..fa5dc3d9 100644 --- a/koyeb/api_async/docs/RegionalDeploymentDefinition.md +++ b/koyeb/api_async/docs/RegionalDeploymentDefinition.md @@ -21,6 +21,7 @@ Name | Type | Description | Notes **skip_cache** | **bool** | | [optional] **mesh** | [**RegionalDeploymentMesh**](RegionalDeploymentMesh.md) | | [optional] [default to RegionalDeploymentMesh.REGIONAL_DEPLOYMENT_MESH_AUTO] **network_policy** | [**NetworkPolicy**](NetworkPolicy.md) | | [optional] +**kill_timeout_secs** | **int** | | [optional] **docker** | [**DockerSource**](DockerSource.md) | | [optional] **git** | [**GitSource**](GitSource.md) | | [optional] **archive** | [**ArchiveSource**](ArchiveSource.md) | | [optional] diff --git a/koyeb/api_async/docs/SandboxMetadata.md b/koyeb/api_async/docs/SandboxMetadata.md index f199bf1a..312f8bc7 100644 --- a/koyeb/api_async/docs/SandboxMetadata.md +++ b/koyeb/api_async/docs/SandboxMetadata.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **public_url** | **str** | | [optional] **routing_key** | **str** | | [optional] +**internal_url** | **str** | | [optional] ## Example diff --git a/koyeb/api_async/docs/ServicePool.md b/koyeb/api_async/docs/ServicePool.md index c920be03..1ab2662f 100644 --- a/koyeb/api_async/docs/ServicePool.md +++ b/koyeb/api_async/docs/ServicePool.md @@ -17,7 +17,6 @@ Name | Type | Description | Notes **status** | [**ServicePoolStatus**](ServicePoolStatus.md) | | [optional] [default to ServicePoolStatus.UNSPECIFIED] **messages** | **List[str]** | | [optional] **generation** | **str** | | [optional] -**customer_id** | **str** | | [optional] ## Example diff --git a/koyeb/api_async/docs/ServiceViewActiveDeployment.md b/koyeb/api_async/docs/ServiceViewActiveDeployment.md new file mode 100644 index 00000000..b46c74da --- /dev/null +++ b/koyeb/api_async/docs/ServiceViewActiveDeployment.md @@ -0,0 +1,34 @@ +# ServiceViewActiveDeployment + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**state** | [**ServiceViewActiveDeploymentState**](ServiceViewActiveDeploymentState.md) | | [optional] [default to ServiceViewActiveDeploymentState.NONE] +**id** | **str** | | [optional] +**missing** | **bool** | | [optional] +**status** | [**DeploymentStatus**](DeploymentStatus.md) | | [optional] [default to DeploymentStatus.PENDING] +**created_at** | **datetime** | | [optional] +**updated_at** | **datetime** | | [optional] + +## Example + +```python +from koyeb.api_async.models.service_view_active_deployment import ServiceViewActiveDeployment + +# TODO update the JSON string below +json = "{}" +# create an instance of ServiceViewActiveDeployment from a JSON string +service_view_active_deployment_instance = ServiceViewActiveDeployment.from_json(json) +# print the JSON string representation of the object +print(ServiceViewActiveDeployment.to_json()) + +# convert the object into a dict +service_view_active_deployment_dict = service_view_active_deployment_instance.to_dict() +# create an instance of ServiceViewActiveDeployment from a dict +service_view_active_deployment_from_dict = ServiceViewActiveDeployment.from_dict(service_view_active_deployment_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/koyeb/api_async/docs/ServiceViewActiveDeploymentState.md b/koyeb/api_async/docs/ServiceViewActiveDeploymentState.md new file mode 100644 index 00000000..40b45f5c --- /dev/null +++ b/koyeb/api_async/docs/ServiceViewActiveDeploymentState.md @@ -0,0 +1,25 @@ +# ServiceViewActiveDeploymentState + +- SLEEPING: The active Deployment is scaled to zero and wakes up on traffic + +## Enum + +* `NONE` (value: `'NONE'`) + +* `STARTING` (value: `'STARTING'`) + +* `HEALTHY` (value: `'HEALTHY'`) + +* `DEGRADED` (value: `'DEGRADED'`) + +* `UNHEALTHY` (value: `'UNHEALTHY'`) + +* `STOPPING` (value: `'STOPPING'`) + +* `PAUSED` (value: `'PAUSED'`) + +* `SLEEPING` (value: `'SLEEPING'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/koyeb/api_async/docs/ServiceViewApp.md b/koyeb/api_async/docs/ServiceViewApp.md new file mode 100644 index 00000000..55e498eb --- /dev/null +++ b/koyeb/api_async/docs/ServiceViewApp.md @@ -0,0 +1,30 @@ +# ServiceViewApp + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] +**name** | **str** | | [optional] + +## Example + +```python +from koyeb.api_async.models.service_view_app import ServiceViewApp + +# TODO update the JSON string below +json = "{}" +# create an instance of ServiceViewApp from a JSON string +service_view_app_instance = ServiceViewApp.from_json(json) +# print the JSON string representation of the object +print(ServiceViewApp.to_json()) + +# convert the object into a dict +service_view_app_dict = service_view_app_instance.to_dict() +# create an instance of ServiceViewApp from a dict +service_view_app_from_dict = ServiceViewApp.from_dict(service_view_app_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/koyeb/api_async/docs/ServiceViewFacet.md b/koyeb/api_async/docs/ServiceViewFacet.md new file mode 100644 index 00000000..e90ee5b3 --- /dev/null +++ b/koyeb/api_async/docs/ServiceViewFacet.md @@ -0,0 +1,30 @@ +# ServiceViewFacet + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**kind** | [**ServiceViewFacetKind**](ServiceViewFacetKind.md) | | [optional] [default to ServiceViewFacetKind.TYPE] +**values** | [**List[ServiceViewFacetValue]**](ServiceViewFacetValue.md) | | [optional] + +## Example + +```python +from koyeb.api_async.models.service_view_facet import ServiceViewFacet + +# TODO update the JSON string below +json = "{}" +# create an instance of ServiceViewFacet from a JSON string +service_view_facet_instance = ServiceViewFacet.from_json(json) +# print the JSON string representation of the object +print(ServiceViewFacet.to_json()) + +# convert the object into a dict +service_view_facet_dict = service_view_facet_instance.to_dict() +# create an instance of ServiceViewFacet from a dict +service_view_facet_from_dict = ServiceViewFacet.from_dict(service_view_facet_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/koyeb/api_async/docs/ServiceViewFacetKind.md b/koyeb/api_async/docs/ServiceViewFacetKind.md new file mode 100644 index 00000000..741fd93f --- /dev/null +++ b/koyeb/api_async/docs/ServiceViewFacetKind.md @@ -0,0 +1,22 @@ +# ServiceViewFacetKind + + +## Enum + +* `TYPE` (value: `'TYPE'`) + +* `STATUS` (value: `'STATUS'`) + +* `REGION` (value: `'REGION'`) + +* `APP` (value: `'APP'`) + +* `ACTIVE_DEPLOYMENT_STATE` (value: `'ACTIVE_DEPLOYMENT_STATE'`) + +* `LATEST_DEPLOYMENT_STATE` (value: `'LATEST_DEPLOYMENT_STATE'`) + +* `NEEDS_ATTENTION` (value: `'NEEDS_ATTENTION'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/koyeb/api_async/docs/ServiceViewFacetValue.md b/koyeb/api_async/docs/ServiceViewFacetValue.md new file mode 100644 index 00000000..435a52da --- /dev/null +++ b/koyeb/api_async/docs/ServiceViewFacetValue.md @@ -0,0 +1,31 @@ +# ServiceViewFacetValue + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | | [optional] +**label** | **str** | | [optional] +**count** | **int** | | [optional] + +## Example + +```python +from koyeb.api_async.models.service_view_facet_value import ServiceViewFacetValue + +# TODO update the JSON string below +json = "{}" +# create an instance of ServiceViewFacetValue from a JSON string +service_view_facet_value_instance = ServiceViewFacetValue.from_json(json) +# print the JSON string representation of the object +print(ServiceViewFacetValue.to_json()) + +# convert the object into a dict +service_view_facet_value_dict = service_view_facet_value_instance.to_dict() +# create an instance of ServiceViewFacetValue from a dict +service_view_facet_value_from_dict = ServiceViewFacetValue.from_dict(service_view_facet_value_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/koyeb/api_async/docs/ServiceViewGroup.md b/koyeb/api_async/docs/ServiceViewGroup.md new file mode 100644 index 00000000..50801da2 --- /dev/null +++ b/koyeb/api_async/docs/ServiceViewGroup.md @@ -0,0 +1,32 @@ +# ServiceViewGroup + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**by** | [**ServiceViewGroupBy**](ServiceViewGroupBy.md) | | [optional] [default to ServiceViewGroupBy.NO_GROUP] +**key** | **str** | | [optional] +**label** | **str** | | [optional] +**count** | **int** | | [optional] + +## Example + +```python +from koyeb.api_async.models.service_view_group import ServiceViewGroup + +# TODO update the JSON string below +json = "{}" +# create an instance of ServiceViewGroup from a JSON string +service_view_group_instance = ServiceViewGroup.from_json(json) +# print the JSON string representation of the object +print(ServiceViewGroup.to_json()) + +# convert the object into a dict +service_view_group_dict = service_view_group_instance.to_dict() +# create an instance of ServiceViewGroup from a dict +service_view_group_from_dict = ServiceViewGroup.from_dict(service_view_group_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/koyeb/api_async/docs/ServiceViewGroupBy.md b/koyeb/api_async/docs/ServiceViewGroupBy.md new file mode 100644 index 00000000..1b49b162 --- /dev/null +++ b/koyeb/api_async/docs/ServiceViewGroupBy.md @@ -0,0 +1,12 @@ +# ServiceViewGroupBy + + +## Enum + +* `NO_GROUP` (value: `'NO_GROUP'`) + +* `APP` (value: `'APP'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/koyeb/api_async/docs/ServiceViewLatestDeployment.md b/koyeb/api_async/docs/ServiceViewLatestDeployment.md new file mode 100644 index 00000000..4ce876da --- /dev/null +++ b/koyeb/api_async/docs/ServiceViewLatestDeployment.md @@ -0,0 +1,34 @@ +# ServiceViewLatestDeployment + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**state** | [**ServiceViewLatestDeploymentState**](ServiceViewLatestDeploymentState.md) | | [optional] [default to ServiceViewLatestDeploymentState.NONE] +**id** | **str** | | [optional] +**missing** | **bool** | | [optional] +**status** | [**DeploymentStatus**](DeploymentStatus.md) | | [optional] [default to DeploymentStatus.PENDING] +**created_at** | **datetime** | | [optional] +**updated_at** | **datetime** | | [optional] + +## Example + +```python +from koyeb.api_async.models.service_view_latest_deployment import ServiceViewLatestDeployment + +# TODO update the JSON string below +json = "{}" +# create an instance of ServiceViewLatestDeployment from a JSON string +service_view_latest_deployment_instance = ServiceViewLatestDeployment.from_json(json) +# print the JSON string representation of the object +print(ServiceViewLatestDeployment.to_json()) + +# convert the object into a dict +service_view_latest_deployment_dict = service_view_latest_deployment_instance.to_dict() +# create an instance of ServiceViewLatestDeployment from a dict +service_view_latest_deployment_from_dict = ServiceViewLatestDeployment.from_dict(service_view_latest_deployment_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/koyeb/api_async/docs/ServiceViewLatestDeploymentState.md b/koyeb/api_async/docs/ServiceViewLatestDeploymentState.md new file mode 100644 index 00000000..4351c0e5 --- /dev/null +++ b/koyeb/api_async/docs/ServiceViewLatestDeploymentState.md @@ -0,0 +1,16 @@ +# ServiceViewLatestDeploymentState + + +## Enum + +* `NONE` (value: `'NONE'`) + +* `STARTING` (value: `'STARTING'`) + +* `STOPPING` (value: `'STOPPING'`) + +* `FAILED` (value: `'FAILED'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/koyeb/api_async/docs/ServiceViewRow.md b/koyeb/api_async/docs/ServiceViewRow.md new file mode 100644 index 00000000..6f7a0f2f --- /dev/null +++ b/koyeb/api_async/docs/ServiceViewRow.md @@ -0,0 +1,43 @@ +# ServiceViewRow + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] +**name** | **str** | | [optional] +**type** | [**ServiceType**](ServiceType.md) | | [optional] [default to ServiceType.INVALID_TYPE] +**status** | [**ServiceStatus**](ServiceStatus.md) | | [optional] [default to ServiceStatus.STARTING] +**messages** | **List[str]** | | [optional] +**created_at** | **datetime** | | [optional] +**updated_at** | **datetime** | | [optional] +**app_id** | **str** | | [optional] +**app** | [**ServiceViewApp**](ServiceViewApp.md) | | [optional] +**active_deployment** | [**ServiceViewActiveDeployment**](ServiceViewActiveDeployment.md) | | [optional] +**latest_deployment** | [**ServiceViewLatestDeployment**](ServiceViewLatestDeployment.md) | | [optional] +**needs_attention** | **bool** | | [optional] +**regions** | **List[str]** | | [optional] +**instance_type** | **str** | | [optional] +**source** | [**ServiceViewSource**](ServiceViewSource.md) | | [optional] + +## Example + +```python +from koyeb.api_async.models.service_view_row import ServiceViewRow + +# TODO update the JSON string below +json = "{}" +# create an instance of ServiceViewRow from a JSON string +service_view_row_instance = ServiceViewRow.from_json(json) +# print the JSON string representation of the object +print(ServiceViewRow.to_json()) + +# convert the object into a dict +service_view_row_dict = service_view_row_instance.to_dict() +# create an instance of ServiceViewRow from a dict +service_view_row_from_dict = ServiceViewRow.from_dict(service_view_row_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/koyeb/api_async/docs/ServiceViewSource.md b/koyeb/api_async/docs/ServiceViewSource.md new file mode 100644 index 00000000..70748eda --- /dev/null +++ b/koyeb/api_async/docs/ServiceViewSource.md @@ -0,0 +1,30 @@ +# ServiceViewSource + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**ServiceViewSourceType**](ServiceViewSourceType.md) | | [optional] [default to ServiceViewSourceType.UNKNOWN] +**reference** | **str** | | [optional] + +## Example + +```python +from koyeb.api_async.models.service_view_source import ServiceViewSource + +# TODO update the JSON string below +json = "{}" +# create an instance of ServiceViewSource from a JSON string +service_view_source_instance = ServiceViewSource.from_json(json) +# print the JSON string representation of the object +print(ServiceViewSource.to_json()) + +# convert the object into a dict +service_view_source_dict = service_view_source_instance.to_dict() +# create an instance of ServiceViewSource from a dict +service_view_source_from_dict = ServiceViewSource.from_dict(service_view_source_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/koyeb/api_async/docs/ServiceViewSourceType.md b/koyeb/api_async/docs/ServiceViewSourceType.md new file mode 100644 index 00000000..ab2b7da7 --- /dev/null +++ b/koyeb/api_async/docs/ServiceViewSourceType.md @@ -0,0 +1,18 @@ +# ServiceViewSourceType + + +## Enum + +* `UNKNOWN` (value: `'UNKNOWN'`) + +* `DOCKER` (value: `'DOCKER'`) + +* `GIT` (value: `'GIT'`) + +* `ARCHIVE` (value: `'ARCHIVE'`) + +* `DATABASE` (value: `'DATABASE'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/koyeb/api_async/docs/ServiceViewsApi.md b/koyeb/api_async/docs/ServiceViewsApi.md new file mode 100644 index 00000000..505eb688 --- /dev/null +++ b/koyeb/api_async/docs/ServiceViewsApi.md @@ -0,0 +1,125 @@ +# koyeb.api_async.ServiceViewsApi + +All URIs are relative to *https://app.koyeb.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**query_services_view**](ServiceViewsApi.md#query_services_view) | **GET** /v1/views/services | Query the Services view + + +# **query_services_view** +> QueryServicesViewReply query_services_view(search=search, filters_types=filters_types, filters_statuses=filters_statuses, filters_regions=filters_regions, filters_app_ids=filters_app_ids, filters_active_deployment_states=filters_active_deployment_states, filters_latest_deployment_states=filters_latest_deployment_states, filters_needs_attention=filters_needs_attention, sort_field=sort_field, sort_direction=sort_direction, group_by=group_by, limit=limit, offset=offset, facets=facets) + +Query the Services view + +Unstable: this endpoint may change without notice. + +Returns Services with their App and Deployment state. Filters, search, +sorting, grouping, counts and facets are all computed on the full +authorized result before pagination. + +### Example + +* Api Key Authentication (Bearer): + +```python +import koyeb.api_async +from koyeb.api_async.models.query_services_view_reply import QueryServicesViewReply +from koyeb.api_async.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://app.koyeb.com +# See configuration.py for a list of all supported configuration parameters. +configuration = koyeb.api_async.Configuration( + host = "https://app.koyeb.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: Bearer +configuration.api_key['Bearer'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Bearer'] = 'Bearer' + +# Enter a context with an instance of the API client +async with koyeb.api_async.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = koyeb.api_async.ServiceViewsApi(api_client) + search = 'search_example' # str | (Optional) Case-insensitive search on the Service name and the App name (optional) + filters_types = ['filters_types_example'] # List[str] | (Optional) Filter on Service types (optional) + filters_statuses = ['filters_statuses_example'] # List[str] | (Optional) Filter on Service statuses (optional) + filters_regions = ['filters_regions_example'] # List[str] | (Optional) Filter on regions of the latest Deployment (optional) + filters_app_ids = ['filters_app_ids_example'] # List[str] | (Optional) Filter on App ids (optional) + filters_active_deployment_states = ['filters_active_deployment_states_example'] # List[str] | (Optional) Filter on active Deployment states - SLEEPING: The active Deployment is scaled to zero and wakes up on traffic (optional) + filters_latest_deployment_states = ['filters_latest_deployment_states_example'] # List[str] | (Optional) Filter on latest Deployment states (optional) + filters_needs_attention = True # bool | (Optional) Filter on Services that need attention (optional) + sort_field = 'CREATED_AT' # str | (optional) (default to 'CREATED_AT') + sort_direction = 'ASC' # str | (optional) (default to 'ASC') + group_by = 'NO_GROUP' # str | (Optional) Group rows by App. Groups are ordered by App name and keep a stable order across pages. Pagination always counts Services (optional) (default to 'NO_GROUP') + limit = 'limit_example' # str | (Optional) The number of items to return (optional) + offset = 'offset_example' # str | (Optional) The offset in the list of item to return (optional) + facets = ['facets_example'] # List[str] | (Optional) Facets to compute on the full result (optional) + + try: + # Query the Services view + api_response = await api_instance.query_services_view(search=search, filters_types=filters_types, filters_statuses=filters_statuses, filters_regions=filters_regions, filters_app_ids=filters_app_ids, filters_active_deployment_states=filters_active_deployment_states, filters_latest_deployment_states=filters_latest_deployment_states, filters_needs_attention=filters_needs_attention, sort_field=sort_field, sort_direction=sort_direction, group_by=group_by, limit=limit, offset=offset, facets=facets) + print("The response of ServiceViewsApi->query_services_view:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ServiceViewsApi->query_services_view: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **search** | **str**| (Optional) Case-insensitive search on the Service name and the App name | [optional] + **filters_types** | [**List[str]**](str.md)| (Optional) Filter on Service types | [optional] + **filters_statuses** | [**List[str]**](str.md)| (Optional) Filter on Service statuses | [optional] + **filters_regions** | [**List[str]**](str.md)| (Optional) Filter on regions of the latest Deployment | [optional] + **filters_app_ids** | [**List[str]**](str.md)| (Optional) Filter on App ids | [optional] + **filters_active_deployment_states** | [**List[str]**](str.md)| (Optional) Filter on active Deployment states - SLEEPING: The active Deployment is scaled to zero and wakes up on traffic | [optional] + **filters_latest_deployment_states** | [**List[str]**](str.md)| (Optional) Filter on latest Deployment states | [optional] + **filters_needs_attention** | **bool**| (Optional) Filter on Services that need attention | [optional] + **sort_field** | **str**| | [optional] [default to 'CREATED_AT'] + **sort_direction** | **str**| | [optional] [default to 'ASC'] + **group_by** | **str**| (Optional) Group rows by App. Groups are ordered by App name and keep a stable order across pages. Pagination always counts Services | [optional] [default to 'NO_GROUP'] + **limit** | **str**| (Optional) The number of items to return | [optional] + **offset** | **str**| (Optional) The offset in the list of item to return | [optional] + **facets** | [**List[str]**](str.md)| (Optional) Facets to compute on the full result | [optional] + +### Return type + +[**QueryServicesViewReply**](QueryServicesViewReply.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | A successful response. | - | +**400** | Validation error | - | +**401** | Returned when the token is not valid. | - | +**403** | Returned when the user does not have permission to access the resource. | - | +**404** | Returned when the resource does not exist. | - | +**500** | Returned in case of server error. | - | +**503** | Service is unavailable. | - | +**0** | An unexpected error response. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/koyeb/api_async/docs/SnapshotStatus.md b/koyeb/api_async/docs/SnapshotStatus.md index bbc2964f..7a0e82c0 100644 --- a/koyeb/api_async/docs/SnapshotStatus.md +++ b/koyeb/api_async/docs/SnapshotStatus.md @@ -15,6 +15,8 @@ * `SNAPSHOT_STATUS_DELETED` (value: `'SNAPSHOT_STATUS_DELETED'`) +* `SNAPSHOT_STATUS_ERROR` (value: `'SNAPSHOT_STATUS_ERROR'`) + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/koyeb/api_async/docs/SnapshotsApi.md b/koyeb/api_async/docs/SnapshotsApi.md index 82994a7a..bb8a0b8a 100644 --- a/koyeb/api_async/docs/SnapshotsApi.md +++ b/koyeb/api_async/docs/SnapshotsApi.md @@ -303,7 +303,7 @@ async with koyeb.api_async.ApiClient(configuration) as api_client: limit = 'limit_example' # str | (Optional) The number of items to return (optional) offset = 'offset_example' # str | (Optional) The offset in the list of item to return (optional) organization_id = 'organization_id_example' # str | (Optional) Filter by organization_id (optional) - statuses = ['statuses_example'] # List[str] | (Optional) Filter by status - SNAPSHOT_STATUS_INVALID: zero value, invalid - SNAPSHOT_STATUS_CREATING: the snapshot is being created - SNAPSHOT_STATUS_AVAILABLE: the snapshot is complete and available - SNAPSHOT_STATUS_MIGRATING: the snapshot is being migrated - SNAPSHOT_STATUS_DELETING: the snapshot is being deleted - SNAPSHOT_STATUS_DELETED: the snapshot is deleted (optional) + statuses = ['statuses_example'] # List[str] | (Optional) Filter by status - SNAPSHOT_STATUS_INVALID: zero value, invalid - SNAPSHOT_STATUS_CREATING: the snapshot is being created - SNAPSHOT_STATUS_AVAILABLE: the snapshot is complete and available - SNAPSHOT_STATUS_MIGRATING: the snapshot is being migrated - SNAPSHOT_STATUS_DELETING: the snapshot is being deleted - SNAPSHOT_STATUS_DELETED: the snapshot is deleted - SNAPSHOT_STATUS_ERROR: the snapshot could not be created (optional) region = 'region_example' # str | (Optional) A filter for the region (optional) ids = ['ids_example'] # List[str] | (Optional) Filter on snapshot ids (optional) @@ -326,7 +326,7 @@ Name | Type | Description | Notes **limit** | **str**| (Optional) The number of items to return | [optional] **offset** | **str**| (Optional) The offset in the list of item to return | [optional] **organization_id** | **str**| (Optional) Filter by organization_id | [optional] - **statuses** | [**List[str]**](str.md)| (Optional) Filter by status - SNAPSHOT_STATUS_INVALID: zero value, invalid - SNAPSHOT_STATUS_CREATING: the snapshot is being created - SNAPSHOT_STATUS_AVAILABLE: the snapshot is complete and available - SNAPSHOT_STATUS_MIGRATING: the snapshot is being migrated - SNAPSHOT_STATUS_DELETING: the snapshot is being deleted - SNAPSHOT_STATUS_DELETED: the snapshot is deleted | [optional] + **statuses** | [**List[str]**](str.md)| (Optional) Filter by status - SNAPSHOT_STATUS_INVALID: zero value, invalid - SNAPSHOT_STATUS_CREATING: the snapshot is being created - SNAPSHOT_STATUS_AVAILABLE: the snapshot is complete and available - SNAPSHOT_STATUS_MIGRATING: the snapshot is being migrated - SNAPSHOT_STATUS_DELETING: the snapshot is being deleted - SNAPSHOT_STATUS_DELETED: the snapshot is deleted - SNAPSHOT_STATUS_ERROR: the snapshot could not be created | [optional] **region** | **str**| (Optional) A filter for the region | [optional] **ids** | [**List[str]**](str.md)| (Optional) Filter on snapshot ids | [optional] diff --git a/koyeb/api_async/exceptions.py b/koyeb/api_async/exceptions.py index 5e517cf3..dc7f14a4 100644 --- a/koyeb/api_async/exceptions.py +++ b/koyeb/api_async/exceptions.py @@ -1,7 +1,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/__init__.py b/koyeb/api_async/models/__init__.py index a78a614e..53fbe313 100644 --- a/koyeb/api_async/models/__init__.py +++ b/koyeb/api_async/models/__init__.py @@ -4,7 +4,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -29,6 +29,7 @@ from koyeb.api_async.models.archive import Archive from koyeb.api_async.models.archive_deployment_metadata import ArchiveDeploymentMetadata from koyeb.api_async.models.archive_source import ArchiveSource +from koyeb.api_async.models.archive_status import ArchiveStatus from koyeb.api_async.models.auto_release import AutoRelease from koyeb.api_async.models.auto_release_group import AutoReleaseGroup from koyeb.api_async.models.autocomplete_reply import AutocompleteReply @@ -237,6 +238,7 @@ ) from koyeb.api_async.models.grpc_health_check import GRPCHealthCheck from koyeb.api_async.models.get_app_reply import GetAppReply +from koyeb.api_async.models.get_archive_reply import GetArchiveReply from koyeb.api_async.models.get_budget_reply import GetBudgetReply from koyeb.api_async.models.get_catalog_instance_reply import GetCatalogInstanceReply from koyeb.api_async.models.get_credential_reply import GetCredentialReply @@ -345,6 +347,9 @@ from koyeb.api_async.models.kgitproxy_repository_provider import ( KgitproxyRepositoryProvider, ) +from koyeb.api_async.models.kmeta_get_organization_workspace_quotas_reply import ( + KmetaGetOrganizationWorkspaceQuotasReply, +) from koyeb.api_async.models.ksearch_app import KsearchApp from koyeb.api_async.models.ksearch_global_deployment import KsearchGlobalDeployment from koyeb.api_async.models.ksearch_instance import KsearchInstance @@ -358,6 +363,7 @@ from koyeb.api_async.models.lifecycle_quotas import LifecycleQuotas from koyeb.api_async.models.list_app_events_reply import ListAppEventsReply from koyeb.api_async.models.list_apps_reply import ListAppsReply +from koyeb.api_async.models.list_archives_reply import ListArchivesReply from koyeb.api_async.models.list_catalog_instances_reply import ( ListCatalogInstancesReply, ) @@ -495,6 +501,15 @@ from koyeb.api_async.models.public_user import PublicUser from koyeb.api_async.models.query_logs_reply import QueryLogsReply from koyeb.api_async.models.query_logs_reply_pagination import QueryLogsReplyPagination +from koyeb.api_async.models.query_services_view_filters import QueryServicesViewFilters +from koyeb.api_async.models.query_services_view_reply import QueryServicesViewReply +from koyeb.api_async.models.query_services_view_sort import QueryServicesViewSort +from koyeb.api_async.models.query_services_view_sort_direction import ( + QueryServicesViewSortDirection, +) +from koyeb.api_async.models.query_services_view_sort_field import ( + QueryServicesViewSortField, +) from koyeb.api_async.models.quota_usage import QuotaUsage from koyeb.api_async.models.quotas import Quotas from koyeb.api_async.models.reactivate_organization_reply import ( @@ -559,6 +574,27 @@ from koyeb.api_async.models.service_summary import ServiceSummary from koyeb.api_async.models.service_type import ServiceType from koyeb.api_async.models.service_usage import ServiceUsage +from koyeb.api_async.models.service_view_active_deployment import ( + ServiceViewActiveDeployment, +) +from koyeb.api_async.models.service_view_active_deployment_state import ( + ServiceViewActiveDeploymentState, +) +from koyeb.api_async.models.service_view_app import ServiceViewApp +from koyeb.api_async.models.service_view_facet import ServiceViewFacet +from koyeb.api_async.models.service_view_facet_kind import ServiceViewFacetKind +from koyeb.api_async.models.service_view_facet_value import ServiceViewFacetValue +from koyeb.api_async.models.service_view_group import ServiceViewGroup +from koyeb.api_async.models.service_view_group_by import ServiceViewGroupBy +from koyeb.api_async.models.service_view_latest_deployment import ( + ServiceViewLatestDeployment, +) +from koyeb.api_async.models.service_view_latest_deployment_state import ( + ServiceViewLatestDeploymentState, +) +from koyeb.api_async.models.service_view_row import ServiceViewRow +from koyeb.api_async.models.service_view_source import ServiceViewSource +from koyeb.api_async.models.service_view_source_type import ServiceViewSourceType from koyeb.api_async.models.snapshot import Snapshot from koyeb.api_async.models.snapshot_status import SnapshotStatus from koyeb.api_async.models.snapshot_type import SnapshotType diff --git a/koyeb/api_async/models/accept_organization_invitation_reply.py b/koyeb/api_async/models/accept_organization_invitation_reply.py index d0927646..144a2f8e 100644 --- a/koyeb/api_async/models/accept_organization_invitation_reply.py +++ b/koyeb/api_async/models/accept_organization_invitation_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/action.py b/koyeb/api_async/models/action.py index 56c31901..a0dd7136 100644 --- a/koyeb/api_async/models/action.py +++ b/koyeb/api_async/models/action.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/activity.py b/koyeb/api_async/models/activity.py index 28e865cc..a2f64405 100644 --- a/koyeb/api_async/models/activity.py +++ b/koyeb/api_async/models/activity.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/activity_list.py b/koyeb/api_async/models/activity_list.py index c91ba853..4e419f5e 100644 --- a/koyeb/api_async/models/activity_list.py +++ b/koyeb/api_async/models/activity_list.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/app.py b/koyeb/api_async/models/app.py index d731859d..2bd1be7e 100644 --- a/koyeb/api_async/models/app.py +++ b/koyeb/api_async/models/app.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/app_event.py b/koyeb/api_async/models/app_event.py index 23a6b3cc..fa1cb8a2 100644 --- a/koyeb/api_async/models/app_event.py +++ b/koyeb/api_async/models/app_event.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/app_life_cycle.py b/koyeb/api_async/models/app_life_cycle.py index b6610fa4..9bc68b99 100644 --- a/koyeb/api_async/models/app_life_cycle.py +++ b/koyeb/api_async/models/app_life_cycle.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -17,7 +17,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, StrictBool +from pydantic import BaseModel, ConfigDict, Field, StrictBool from typing import Any, ClassVar, Dict, List, Optional from typing import Optional, Set from typing_extensions import Self @@ -29,7 +29,10 @@ class AppLifeCycle(BaseModel): AppLifeCycle """ # noqa: E501 - delete_when_empty: Optional[StrictBool] = None + delete_when_empty: Optional[StrictBool] = Field( + default=None, + description="If true, the app is deleted once it has no service left: either when its last service is deleted or, for an app that never had a service, once it is older than 15 minutes.", + ) __properties: ClassVar[List[str]] = ["delete_when_empty"] model_config = ConfigDict( diff --git a/koyeb/api_async/models/app_list_item.py b/koyeb/api_async/models/app_list_item.py index 83ce4e2e..be6fd8fe 100644 --- a/koyeb/api_async/models/app_list_item.py +++ b/koyeb/api_async/models/app_list_item.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/app_status.py b/koyeb/api_async/models/app_status.py index 73660fd3..bd3fafc1 100644 --- a/koyeb/api_async/models/app_status.py +++ b/koyeb/api_async/models/app_status.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/app_usage.py b/koyeb/api_async/models/app_usage.py index e79881ab..e006d15e 100644 --- a/koyeb/api_async/models/app_usage.py +++ b/koyeb/api_async/models/app_usage.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/apps_summary.py b/koyeb/api_async/models/apps_summary.py index 86f1abe0..0a29ba63 100644 --- a/koyeb/api_async/models/apps_summary.py +++ b/koyeb/api_async/models/apps_summary.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/archive.py b/koyeb/api_async/models/archive.py index 098f9484..5d9f1aba 100644 --- a/koyeb/api_async/models/archive.py +++ b/koyeb/api_async/models/archive.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -20,6 +20,7 @@ from datetime import datetime from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List, Optional +from koyeb.api_async.models.archive_status import ArchiveStatus from typing import Optional, Set from typing_extensions import Self from pydantic_core import to_jsonable_python @@ -51,6 +52,14 @@ class Archive(BaseModel): default=None, description="This field is automatically set by Koyeb when the archive is garbage collected.", ) + download_url: Optional[StrictStr] = Field( + default=None, + description="A signed URL to download the archive. Getting an archive signs a new one when it has less than 5 minutes left, valid for 24 hours.", + ) + download_url_deadline: Optional[datetime] = Field( + default=None, description="When download_url expires." + ) + status: Optional[ArchiveStatus] = ArchiveStatus.ARCHIVE_STATUS_INVALID __properties: ClassVar[List[str]] = [ "id", "organization_id", @@ -58,6 +67,9 @@ class Archive(BaseModel): "size", "created_at", "deleted_at", + "download_url", + "download_url_deadline", + "status", ] model_config = ConfigDict( @@ -116,6 +128,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "size": obj.get("size"), "created_at": obj.get("created_at"), "deleted_at": obj.get("deleted_at"), + "download_url": obj.get("download_url"), + "download_url_deadline": obj.get("download_url_deadline"), + "status": obj.get("status") + if obj.get("status") is not None + else ArchiveStatus.ARCHIVE_STATUS_INVALID, } ) return _obj diff --git a/koyeb/api_async/models/archive_deployment_metadata.py b/koyeb/api_async/models/archive_deployment_metadata.py index 2ea27ec8..d08809fe 100644 --- a/koyeb/api_async/models/archive_deployment_metadata.py +++ b/koyeb/api_async/models/archive_deployment_metadata.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/archive_source.py b/koyeb/api_async/models/archive_source.py index 0412051f..33b407ee 100644 --- a/koyeb/api_async/models/archive_source.py +++ b/koyeb/api_async/models/archive_source.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/archive_status.py b/koyeb/api_async/models/archive_status.py new file mode 100644 index 00000000..f163f86a --- /dev/null +++ b/koyeb/api_async/models/archive_status.py @@ -0,0 +1,37 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class ArchiveStatus(str, Enum): + """ + ArchiveStatus + """ + + """ + allowed enum values + """ + ARCHIVE_STATUS_INVALID = "ARCHIVE_STATUS_INVALID" + ARCHIVE_STATUS_HEALTHY = "ARCHIVE_STATUS_HEALTHY" + ARCHIVE_STATUS_DELETING = "ARCHIVE_STATUS_DELETING" + ARCHIVE_STATUS_DELETED = "ARCHIVE_STATUS_DELETED" + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of ArchiveStatus from a JSON string""" + return cls(json.loads(json_str)) diff --git a/koyeb/api_async/models/auto_release.py b/koyeb/api_async/models/auto_release.py index f39c6ff0..febdc1d5 100644 --- a/koyeb/api_async/models/auto_release.py +++ b/koyeb/api_async/models/auto_release.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/auto_release_group.py b/koyeb/api_async/models/auto_release_group.py index 72aa4e3a..e16bc1e0 100644 --- a/koyeb/api_async/models/auto_release_group.py +++ b/koyeb/api_async/models/auto_release_group.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/autocomplete_reply.py b/koyeb/api_async/models/autocomplete_reply.py index d34a31c5..0825c11a 100644 --- a/koyeb/api_async/models/autocomplete_reply.py +++ b/koyeb/api_async/models/autocomplete_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/autocomplete_request.py b/koyeb/api_async/models/autocomplete_request.py index 23deac16..2c68078a 100644 --- a/koyeb/api_async/models/autocomplete_request.py +++ b/koyeb/api_async/models/autocomplete_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/availability_level.py b/koyeb/api_async/models/availability_level.py index dcda535b..1fcd44a4 100644 --- a/koyeb/api_async/models/availability_level.py +++ b/koyeb/api_async/models/availability_level.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/azure_container_registry_configuration.py b/koyeb/api_async/models/azure_container_registry_configuration.py index 4c23b323..2d417816 100644 --- a/koyeb/api_async/models/azure_container_registry_configuration.py +++ b/koyeb/api_async/models/azure_container_registry_configuration.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/basic_auth_policy.py b/koyeb/api_async/models/basic_auth_policy.py index 85eddef8..2e20901f 100644 --- a/koyeb/api_async/models/basic_auth_policy.py +++ b/koyeb/api_async/models/basic_auth_policy.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/budget.py b/koyeb/api_async/models/budget.py index d811b63a..46c21343 100644 --- a/koyeb/api_async/models/budget.py +++ b/koyeb/api_async/models/budget.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/buildpack_builder.py b/koyeb/api_async/models/buildpack_builder.py index 31d6f93f..edb5abdb 100644 --- a/koyeb/api_async/models/buildpack_builder.py +++ b/koyeb/api_async/models/buildpack_builder.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/canny_auth_reply.py b/koyeb/api_async/models/canny_auth_reply.py index 5475250c..2f98f5f5 100644 --- a/koyeb/api_async/models/canny_auth_reply.py +++ b/koyeb/api_async/models/canny_auth_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/catalog_gpu_details.py b/koyeb/api_async/models/catalog_gpu_details.py index 5a7321ae..1a1a2d28 100644 --- a/koyeb/api_async/models/catalog_gpu_details.py +++ b/koyeb/api_async/models/catalog_gpu_details.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/catalog_instance.py b/koyeb/api_async/models/catalog_instance.py index 97738831..edadb744 100644 --- a/koyeb/api_async/models/catalog_instance.py +++ b/koyeb/api_async/models/catalog_instance.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/catalog_instance_list_item.py b/koyeb/api_async/models/catalog_instance_list_item.py index f158cf1c..d841c01b 100644 --- a/koyeb/api_async/models/catalog_instance_list_item.py +++ b/koyeb/api_async/models/catalog_instance_list_item.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/catalog_usage.py b/koyeb/api_async/models/catalog_usage.py index 3ed8f12a..aafa3c40 100644 --- a/koyeb/api_async/models/catalog_usage.py +++ b/koyeb/api_async/models/catalog_usage.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/check_coupon_reply.py b/koyeb/api_async/models/check_coupon_reply.py index 57e0905c..74f630e5 100644 --- a/koyeb/api_async/models/check_coupon_reply.py +++ b/koyeb/api_async/models/check_coupon_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/clear_idenfy_verification_result_request.py b/koyeb/api_async/models/clear_idenfy_verification_result_request.py index ad64d103..5bd098f9 100644 --- a/koyeb/api_async/models/clear_idenfy_verification_result_request.py +++ b/koyeb/api_async/models/clear_idenfy_verification_result_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/compose_reply.py b/koyeb/api_async/models/compose_reply.py index cffb45e9..cf634219 100644 --- a/koyeb/api_async/models/compose_reply.py +++ b/koyeb/api_async/models/compose_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/config_file.py b/koyeb/api_async/models/config_file.py index 01300f05..7aab95ce 100644 --- a/koyeb/api_async/models/config_file.py +++ b/koyeb/api_async/models/config_file.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/confirm_payment_authorization_reply.py b/koyeb/api_async/models/confirm_payment_authorization_reply.py index 353145a4..6764fe9c 100644 --- a/koyeb/api_async/models/confirm_payment_authorization_reply.py +++ b/koyeb/api_async/models/confirm_payment_authorization_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/create_access_token_reply.py b/koyeb/api_async/models/create_access_token_reply.py index 4e8d896b..99852106 100644 --- a/koyeb/api_async/models/create_access_token_reply.py +++ b/koyeb/api_async/models/create_access_token_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/create_access_token_request.py b/koyeb/api_async/models/create_access_token_request.py index fc62077c..1e1f2e4f 100644 --- a/koyeb/api_async/models/create_access_token_request.py +++ b/koyeb/api_async/models/create_access_token_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/create_account_request.py b/koyeb/api_async/models/create_account_request.py index a3ebcf36..7d22ca5c 100644 --- a/koyeb/api_async/models/create_account_request.py +++ b/koyeb/api_async/models/create_account_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/create_app.py b/koyeb/api_async/models/create_app.py index 9fd0fd7e..03afc696 100644 --- a/koyeb/api_async/models/create_app.py +++ b/koyeb/api_async/models/create_app.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/create_app_reply.py b/koyeb/api_async/models/create_app_reply.py index c4d68da7..eb412c80 100644 --- a/koyeb/api_async/models/create_app_reply.py +++ b/koyeb/api_async/models/create_app_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/create_archive.py b/koyeb/api_async/models/create_archive.py index 22f983d5..f180e596 100644 --- a/koyeb/api_async/models/create_archive.py +++ b/koyeb/api_async/models/create_archive.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/create_archive_reply.py b/koyeb/api_async/models/create_archive_reply.py index 61f2c4fc..76d5fcf6 100644 --- a/koyeb/api_async/models/create_archive_reply.py +++ b/koyeb/api_async/models/create_archive_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/create_budget_reply.py b/koyeb/api_async/models/create_budget_reply.py index 0e9122d9..ddea76c0 100644 --- a/koyeb/api_async/models/create_budget_reply.py +++ b/koyeb/api_async/models/create_budget_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/create_compose.py b/koyeb/api_async/models/create_compose.py index 30479d67..18bcdd10 100644 --- a/koyeb/api_async/models/create_compose.py +++ b/koyeb/api_async/models/create_compose.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/create_credential.py b/koyeb/api_async/models/create_credential.py index 1d04fe0b..12fb6aa5 100644 --- a/koyeb/api_async/models/create_credential.py +++ b/koyeb/api_async/models/create_credential.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/create_credential_reply.py b/koyeb/api_async/models/create_credential_reply.py index d7adb4a0..44241626 100644 --- a/koyeb/api_async/models/create_credential_reply.py +++ b/koyeb/api_async/models/create_credential_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/create_domain.py b/koyeb/api_async/models/create_domain.py index 6a3a50bc..65eac93e 100644 --- a/koyeb/api_async/models/create_domain.py +++ b/koyeb/api_async/models/create_domain.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/create_domain_reply.py b/koyeb/api_async/models/create_domain_reply.py index 5fb21b3a..f96ccae4 100644 --- a/koyeb/api_async/models/create_domain_reply.py +++ b/koyeb/api_async/models/create_domain_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/create_instance_snapshot_reply.py b/koyeb/api_async/models/create_instance_snapshot_reply.py index 154bc949..541c976a 100644 --- a/koyeb/api_async/models/create_instance_snapshot_reply.py +++ b/koyeb/api_async/models/create_instance_snapshot_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/create_instance_snapshot_request.py b/koyeb/api_async/models/create_instance_snapshot_request.py index 1dff9775..8bd3f141 100644 --- a/koyeb/api_async/models/create_instance_snapshot_request.py +++ b/koyeb/api_async/models/create_instance_snapshot_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/create_organization_invitation_reply.py b/koyeb/api_async/models/create_organization_invitation_reply.py index a7b7bc3e..8d0407c9 100644 --- a/koyeb/api_async/models/create_organization_invitation_reply.py +++ b/koyeb/api_async/models/create_organization_invitation_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/create_organization_invitation_request.py b/koyeb/api_async/models/create_organization_invitation_request.py index 0bf58fc4..8984c8ca 100644 --- a/koyeb/api_async/models/create_organization_invitation_request.py +++ b/koyeb/api_async/models/create_organization_invitation_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/create_organization_reply.py b/koyeb/api_async/models/create_organization_reply.py index 33703d38..553b5004 100644 --- a/koyeb/api_async/models/create_organization_reply.py +++ b/koyeb/api_async/models/create_organization_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/create_organization_request.py b/koyeb/api_async/models/create_organization_request.py index e56892d4..5f9b4ba1 100644 --- a/koyeb/api_async/models/create_organization_request.py +++ b/koyeb/api_async/models/create_organization_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/create_payment_authorization_reply.py b/koyeb/api_async/models/create_payment_authorization_reply.py index 1f35153c..d49fbff0 100644 --- a/koyeb/api_async/models/create_payment_authorization_reply.py +++ b/koyeb/api_async/models/create_payment_authorization_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/create_persistent_volume_reply.py b/koyeb/api_async/models/create_persistent_volume_reply.py index fceb50f8..55381345 100644 --- a/koyeb/api_async/models/create_persistent_volume_reply.py +++ b/koyeb/api_async/models/create_persistent_volume_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/create_persistent_volume_request.py b/koyeb/api_async/models/create_persistent_volume_request.py index b3f06b29..d055a83f 100644 --- a/koyeb/api_async/models/create_persistent_volume_request.py +++ b/koyeb/api_async/models/create_persistent_volume_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/create_project.py b/koyeb/api_async/models/create_project.py index 0bde34b8..77d8c26c 100644 --- a/koyeb/api_async/models/create_project.py +++ b/koyeb/api_async/models/create_project.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/create_project_reply.py b/koyeb/api_async/models/create_project_reply.py index 95eca82b..91c20e93 100644 --- a/koyeb/api_async/models/create_project_reply.py +++ b/koyeb/api_async/models/create_project_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/create_secret.py b/koyeb/api_async/models/create_secret.py index f461222f..bc5b93b0 100644 --- a/koyeb/api_async/models/create_secret.py +++ b/koyeb/api_async/models/create_secret.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/create_secret_reply.py b/koyeb/api_async/models/create_secret_reply.py index e4c998d2..81de3391 100644 --- a/koyeb/api_async/models/create_secret_reply.py +++ b/koyeb/api_async/models/create_secret_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/create_service.py b/koyeb/api_async/models/create_service.py index aeb3543f..12260f8d 100644 --- a/koyeb/api_async/models/create_service.py +++ b/koyeb/api_async/models/create_service.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/create_service_pool.py b/koyeb/api_async/models/create_service_pool.py index 7ca696c1..b33abdb4 100644 --- a/koyeb/api_async/models/create_service_pool.py +++ b/koyeb/api_async/models/create_service_pool.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/create_service_pool_reply.py b/koyeb/api_async/models/create_service_pool_reply.py index f3954aad..9b92af95 100644 --- a/koyeb/api_async/models/create_service_pool_reply.py +++ b/koyeb/api_async/models/create_service_pool_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/create_service_reply.py b/koyeb/api_async/models/create_service_reply.py index c46d793a..eaf20ae8 100644 --- a/koyeb/api_async/models/create_service_reply.py +++ b/koyeb/api_async/models/create_service_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/create_snapshot_reply.py b/koyeb/api_async/models/create_snapshot_reply.py index 7fff1391..e4a73bbb 100644 --- a/koyeb/api_async/models/create_snapshot_reply.py +++ b/koyeb/api_async/models/create_snapshot_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/create_snapshot_request.py b/koyeb/api_async/models/create_snapshot_request.py index 7a73ac71..79b90549 100644 --- a/koyeb/api_async/models/create_snapshot_request.py +++ b/koyeb/api_async/models/create_snapshot_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/create_stage_attempt_request.py b/koyeb/api_async/models/create_stage_attempt_request.py index 9b1ef8f1..d70b7393 100644 --- a/koyeb/api_async/models/create_stage_attempt_request.py +++ b/koyeb/api_async/models/create_stage_attempt_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/credential.py b/koyeb/api_async/models/credential.py index d062909c..c030cfb5 100644 --- a/koyeb/api_async/models/credential.py +++ b/koyeb/api_async/models/credential.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/credential_type.py b/koyeb/api_async/models/credential_type.py index 3d835bd3..c3679dd7 100644 --- a/koyeb/api_async/models/credential_type.py +++ b/koyeb/api_async/models/credential_type.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/database_deployment_metadata.py b/koyeb/api_async/models/database_deployment_metadata.py index f77b1991..6611da5c 100644 --- a/koyeb/api_async/models/database_deployment_metadata.py +++ b/koyeb/api_async/models/database_deployment_metadata.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/database_role_password.py b/koyeb/api_async/models/database_role_password.py index c5205862..08850fe2 100644 --- a/koyeb/api_async/models/database_role_password.py +++ b/koyeb/api_async/models/database_role_password.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/database_source.py b/koyeb/api_async/models/database_source.py index 14308a66..b934797a 100644 --- a/koyeb/api_async/models/database_source.py +++ b/koyeb/api_async/models/database_source.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/database_usage.py b/koyeb/api_async/models/database_usage.py index 67210716..7410cdca 100644 --- a/koyeb/api_async/models/database_usage.py +++ b/koyeb/api_async/models/database_usage.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/database_usage_details.py b/koyeb/api_async/models/database_usage_details.py index 12ba6e3c..51d84607 100644 --- a/koyeb/api_async/models/database_usage_details.py +++ b/koyeb/api_async/models/database_usage_details.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/datacenter_list_item.py b/koyeb/api_async/models/datacenter_list_item.py index 3b395b3b..4c08a728 100644 --- a/koyeb/api_async/models/datacenter_list_item.py +++ b/koyeb/api_async/models/datacenter_list_item.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/deactivate_organization_reply.py b/koyeb/api_async/models/deactivate_organization_reply.py index 74a8bf88..1871caf5 100644 --- a/koyeb/api_async/models/deactivate_organization_reply.py +++ b/koyeb/api_async/models/deactivate_organization_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/deactivate_organization_request.py b/koyeb/api_async/models/deactivate_organization_request.py index 14d6bbd5..929b07c3 100644 --- a/koyeb/api_async/models/deactivate_organization_request.py +++ b/koyeb/api_async/models/deactivate_organization_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/declare_stage_progress_request.py b/koyeb/api_async/models/declare_stage_progress_request.py index e9bf6497..a8052299 100644 --- a/koyeb/api_async/models/declare_stage_progress_request.py +++ b/koyeb/api_async/models/declare_stage_progress_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/declare_step_progress_request.py b/koyeb/api_async/models/declare_step_progress_request.py index c9da67b9..0bcbb6fe 100644 --- a/koyeb/api_async/models/declare_step_progress_request.py +++ b/koyeb/api_async/models/declare_step_progress_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/decline_organization_invitation_reply.py b/koyeb/api_async/models/decline_organization_invitation_reply.py index 86ed79cf..c5548542 100644 --- a/koyeb/api_async/models/decline_organization_invitation_reply.py +++ b/koyeb/api_async/models/decline_organization_invitation_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/delete_instance_snapshot_reply.py b/koyeb/api_async/models/delete_instance_snapshot_reply.py index 1588aba1..e002825a 100644 --- a/koyeb/api_async/models/delete_instance_snapshot_reply.py +++ b/koyeb/api_async/models/delete_instance_snapshot_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/delete_organization_reply.py b/koyeb/api_async/models/delete_organization_reply.py index 6202193c..72c792a0 100644 --- a/koyeb/api_async/models/delete_organization_reply.py +++ b/koyeb/api_async/models/delete_organization_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/delete_persistent_volume_reply.py b/koyeb/api_async/models/delete_persistent_volume_reply.py index 11416b47..2478e109 100644 --- a/koyeb/api_async/models/delete_persistent_volume_reply.py +++ b/koyeb/api_async/models/delete_persistent_volume_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/delete_snapshot_reply.py b/koyeb/api_async/models/delete_snapshot_reply.py index 11c92329..1d2d70e5 100644 --- a/koyeb/api_async/models/delete_snapshot_reply.py +++ b/koyeb/api_async/models/delete_snapshot_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/delete_user_reply.py b/koyeb/api_async/models/delete_user_reply.py index 7d86ce58..b5f4f5b6 100644 --- a/koyeb/api_async/models/delete_user_reply.py +++ b/koyeb/api_async/models/delete_user_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/deployment.py b/koyeb/api_async/models/deployment.py index 1e636ef4..ef6e6df9 100644 --- a/koyeb/api_async/models/deployment.py +++ b/koyeb/api_async/models/deployment.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/deployment_database_info.py b/koyeb/api_async/models/deployment_database_info.py index 4f1d78b8..f0192eaa 100644 --- a/koyeb/api_async/models/deployment_database_info.py +++ b/koyeb/api_async/models/deployment_database_info.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/deployment_definition.py b/koyeb/api_async/models/deployment_definition.py index 873d640d..c58724e3 100644 --- a/koyeb/api_async/models/deployment_definition.py +++ b/koyeb/api_async/models/deployment_definition.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -17,7 +17,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional from koyeb.api_async.models.archive_source import ArchiveSource from koyeb.api_async.models.config_file import ConfigFile @@ -65,6 +65,7 @@ class DeploymentDefinition(BaseModel): skip_cache: Optional[StrictBool] = None mesh: Optional[DeploymentMesh] = DeploymentMesh.DEPLOYMENT_MESH_AUTO network_policy: Optional[NetworkPolicy] = None + kill_timeout_secs: Optional[StrictInt] = None docker: Optional[DockerSource] = None git: Optional[GitSource] = None database: Optional[DatabaseSource] = None @@ -86,6 +87,7 @@ class DeploymentDefinition(BaseModel): "skip_cache", "mesh", "network_policy", + "kill_timeout_secs", "docker", "git", "database", @@ -294,6 +296,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "network_policy": NetworkPolicy.from_dict(obj["network_policy"]) if obj.get("network_policy") is not None else None, + "kill_timeout_secs": obj.get("kill_timeout_secs"), "docker": DockerSource.from_dict(obj["docker"]) if obj.get("docker") is not None else None, diff --git a/koyeb/api_async/models/deployment_definition_type.py b/koyeb/api_async/models/deployment_definition_type.py index c3014a7e..032f48a1 100644 --- a/koyeb/api_async/models/deployment_definition_type.py +++ b/koyeb/api_async/models/deployment_definition_type.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/deployment_env.py b/koyeb/api_async/models/deployment_env.py index 1ecef1e5..baab50c6 100644 --- a/koyeb/api_async/models/deployment_env.py +++ b/koyeb/api_async/models/deployment_env.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/deployment_event.py b/koyeb/api_async/models/deployment_event.py index 00cd2493..58a58b33 100644 --- a/koyeb/api_async/models/deployment_event.py +++ b/koyeb/api_async/models/deployment_event.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/deployment_health_check.py b/koyeb/api_async/models/deployment_health_check.py index db47a597..2913e134 100644 --- a/koyeb/api_async/models/deployment_health_check.py +++ b/koyeb/api_async/models/deployment_health_check.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/deployment_instance_type.py b/koyeb/api_async/models/deployment_instance_type.py index 9c9c866e..19317c52 100644 --- a/koyeb/api_async/models/deployment_instance_type.py +++ b/koyeb/api_async/models/deployment_instance_type.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/deployment_list_item.py b/koyeb/api_async/models/deployment_list_item.py index 20706644..03bd0d89 100644 --- a/koyeb/api_async/models/deployment_list_item.py +++ b/koyeb/api_async/models/deployment_list_item.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/deployment_mesh.py b/koyeb/api_async/models/deployment_mesh.py index 6b9ce078..1aaabe3e 100644 --- a/koyeb/api_async/models/deployment_mesh.py +++ b/koyeb/api_async/models/deployment_mesh.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/deployment_metadata.py b/koyeb/api_async/models/deployment_metadata.py index 3ea3c4b8..3dd5e8df 100644 --- a/koyeb/api_async/models/deployment_metadata.py +++ b/koyeb/api_async/models/deployment_metadata.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/deployment_neon_postgres_database_info.py b/koyeb/api_async/models/deployment_neon_postgres_database_info.py index 2b05c6ee..3f11f664 100644 --- a/koyeb/api_async/models/deployment_neon_postgres_database_info.py +++ b/koyeb/api_async/models/deployment_neon_postgres_database_info.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/deployment_neon_postgres_database_info_role.py b/koyeb/api_async/models/deployment_neon_postgres_database_info_role.py index 3fb284df..e5878793 100644 --- a/koyeb/api_async/models/deployment_neon_postgres_database_info_role.py +++ b/koyeb/api_async/models/deployment_neon_postgres_database_info_role.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/deployment_port.py b/koyeb/api_async/models/deployment_port.py index c3f06c05..9fa8f690 100644 --- a/koyeb/api_async/models/deployment_port.py +++ b/koyeb/api_async/models/deployment_port.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/deployment_provisioning_info.py b/koyeb/api_async/models/deployment_provisioning_info.py index 0ad636b5..60d38b3e 100644 --- a/koyeb/api_async/models/deployment_provisioning_info.py +++ b/koyeb/api_async/models/deployment_provisioning_info.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/deployment_provisioning_info_stage.py b/koyeb/api_async/models/deployment_provisioning_info_stage.py index 3e9ed301..79a33d95 100644 --- a/koyeb/api_async/models/deployment_provisioning_info_stage.py +++ b/koyeb/api_async/models/deployment_provisioning_info_stage.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/deployment_provisioning_info_stage_build_attempt.py b/koyeb/api_async/models/deployment_provisioning_info_stage_build_attempt.py index cc3618db..dfd360e2 100644 --- a/koyeb/api_async/models/deployment_provisioning_info_stage_build_attempt.py +++ b/koyeb/api_async/models/deployment_provisioning_info_stage_build_attempt.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/deployment_provisioning_info_stage_build_attempt_build_step.py b/koyeb/api_async/models/deployment_provisioning_info_stage_build_attempt_build_step.py index 8b78d2e3..f22ce0d8 100644 --- a/koyeb/api_async/models/deployment_provisioning_info_stage_build_attempt_build_step.py +++ b/koyeb/api_async/models/deployment_provisioning_info_stage_build_attempt_build_step.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/deployment_provisioning_info_stage_status.py b/koyeb/api_async/models/deployment_provisioning_info_stage_status.py index 837e5851..db021893 100644 --- a/koyeb/api_async/models/deployment_provisioning_info_stage_status.py +++ b/koyeb/api_async/models/deployment_provisioning_info_stage_status.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/deployment_proxy_port.py b/koyeb/api_async/models/deployment_proxy_port.py index bba9d061..6cbd9609 100644 --- a/koyeb/api_async/models/deployment_proxy_port.py +++ b/koyeb/api_async/models/deployment_proxy_port.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/deployment_proxy_port_metadata.py b/koyeb/api_async/models/deployment_proxy_port_metadata.py index e94a6f4d..90147f9f 100644 --- a/koyeb/api_async/models/deployment_proxy_port_metadata.py +++ b/koyeb/api_async/models/deployment_proxy_port_metadata.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/deployment_role.py b/koyeb/api_async/models/deployment_role.py index 649f75f0..b4052032 100644 --- a/koyeb/api_async/models/deployment_role.py +++ b/koyeb/api_async/models/deployment_role.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/deployment_route.py b/koyeb/api_async/models/deployment_route.py index 1bca1989..11f043a3 100644 --- a/koyeb/api_async/models/deployment_route.py +++ b/koyeb/api_async/models/deployment_route.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/deployment_scaling.py b/koyeb/api_async/models/deployment_scaling.py index 08f5b509..5501cf07 100644 --- a/koyeb/api_async/models/deployment_scaling.py +++ b/koyeb/api_async/models/deployment_scaling.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/deployment_scaling_target.py b/koyeb/api_async/models/deployment_scaling_target.py index d5da51c7..c72f1f4e 100644 --- a/koyeb/api_async/models/deployment_scaling_target.py +++ b/koyeb/api_async/models/deployment_scaling_target.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/deployment_scaling_target_average_cpu.py b/koyeb/api_async/models/deployment_scaling_target_average_cpu.py index 21ce94ae..1dec7dea 100644 --- a/koyeb/api_async/models/deployment_scaling_target_average_cpu.py +++ b/koyeb/api_async/models/deployment_scaling_target_average_cpu.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/deployment_scaling_target_average_mem.py b/koyeb/api_async/models/deployment_scaling_target_average_mem.py index 0193838e..4670c8bb 100644 --- a/koyeb/api_async/models/deployment_scaling_target_average_mem.py +++ b/koyeb/api_async/models/deployment_scaling_target_average_mem.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/deployment_scaling_target_concurrent_requests.py b/koyeb/api_async/models/deployment_scaling_target_concurrent_requests.py index a43c46e0..c271defd 100644 --- a/koyeb/api_async/models/deployment_scaling_target_concurrent_requests.py +++ b/koyeb/api_async/models/deployment_scaling_target_concurrent_requests.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/deployment_scaling_target_requests_per_second.py b/koyeb/api_async/models/deployment_scaling_target_requests_per_second.py index 5d74a068..349b82ac 100644 --- a/koyeb/api_async/models/deployment_scaling_target_requests_per_second.py +++ b/koyeb/api_async/models/deployment_scaling_target_requests_per_second.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/deployment_scaling_target_requests_response_time.py b/koyeb/api_async/models/deployment_scaling_target_requests_response_time.py index 2865cfd1..f07f80da 100644 --- a/koyeb/api_async/models/deployment_scaling_target_requests_response_time.py +++ b/koyeb/api_async/models/deployment_scaling_target_requests_response_time.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/deployment_scaling_target_sleep_idle_delay.py b/koyeb/api_async/models/deployment_scaling_target_sleep_idle_delay.py index c5738f84..74c6151a 100644 --- a/koyeb/api_async/models/deployment_scaling_target_sleep_idle_delay.py +++ b/koyeb/api_async/models/deployment_scaling_target_sleep_idle_delay.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/deployment_status.py b/koyeb/api_async/models/deployment_status.py index c4b733c9..64db15d1 100644 --- a/koyeb/api_async/models/deployment_status.py +++ b/koyeb/api_async/models/deployment_status.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/deployment_strategy.py b/koyeb/api_async/models/deployment_strategy.py index 004b75ef..886a16c9 100644 --- a/koyeb/api_async/models/deployment_strategy.py +++ b/koyeb/api_async/models/deployment_strategy.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/deployment_strategy_type.py b/koyeb/api_async/models/deployment_strategy_type.py index 3c82cbd1..ac2ac3fa 100644 --- a/koyeb/api_async/models/deployment_strategy_type.py +++ b/koyeb/api_async/models/deployment_strategy_type.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/deployment_volume.py b/koyeb/api_async/models/deployment_volume.py index b0c27f45..49934fab 100644 --- a/koyeb/api_async/models/deployment_volume.py +++ b/koyeb/api_async/models/deployment_volume.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/desired_deployment.py b/koyeb/api_async/models/desired_deployment.py index 6fc6c357..9c10b202 100644 --- a/koyeb/api_async/models/desired_deployment.py +++ b/koyeb/api_async/models/desired_deployment.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/desired_deployment_group.py b/koyeb/api_async/models/desired_deployment_group.py index 49e7d8ed..d4ac8787 100644 --- a/koyeb/api_async/models/desired_deployment_group.py +++ b/koyeb/api_async/models/desired_deployment_group.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/digital_ocean_registry_configuration.py b/koyeb/api_async/models/digital_ocean_registry_configuration.py index 814943ff..b9e2fe56 100644 --- a/koyeb/api_async/models/digital_ocean_registry_configuration.py +++ b/koyeb/api_async/models/digital_ocean_registry_configuration.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/discourse_auth_reply.py b/koyeb/api_async/models/discourse_auth_reply.py index ac8199be..15a6c014 100644 --- a/koyeb/api_async/models/discourse_auth_reply.py +++ b/koyeb/api_async/models/discourse_auth_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/discourse_auth_request.py b/koyeb/api_async/models/discourse_auth_request.py index 857708e1..310336b6 100644 --- a/koyeb/api_async/models/discourse_auth_request.py +++ b/koyeb/api_async/models/discourse_auth_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/docker_builder.py b/koyeb/api_async/models/docker_builder.py index 4dd66bfd..c78c736a 100644 --- a/koyeb/api_async/models/docker_builder.py +++ b/koyeb/api_async/models/docker_builder.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/docker_deployment_metadata.py b/koyeb/api_async/models/docker_deployment_metadata.py index 9d466126..5c8553db 100644 --- a/koyeb/api_async/models/docker_deployment_metadata.py +++ b/koyeb/api_async/models/docker_deployment_metadata.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/docker_hub_registry_configuration.py b/koyeb/api_async/models/docker_hub_registry_configuration.py index 18b48c74..62dc525f 100644 --- a/koyeb/api_async/models/docker_hub_registry_configuration.py +++ b/koyeb/api_async/models/docker_hub_registry_configuration.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/docker_source.py b/koyeb/api_async/models/docker_source.py index b6793b6a..defc9dd1 100644 --- a/koyeb/api_async/models/docker_source.py +++ b/koyeb/api_async/models/docker_source.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/domain.py b/koyeb/api_async/models/domain.py index b59f8ab4..09128ca7 100644 --- a/koyeb/api_async/models/domain.py +++ b/koyeb/api_async/models/domain.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/domain_load_balancer_koyeb.py b/koyeb/api_async/models/domain_load_balancer_koyeb.py index a23d93d1..eebde5ff 100644 --- a/koyeb/api_async/models/domain_load_balancer_koyeb.py +++ b/koyeb/api_async/models/domain_load_balancer_koyeb.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/domain_load_balancer_quotas.py b/koyeb/api_async/models/domain_load_balancer_quotas.py index f103cb75..5bca4122 100644 --- a/koyeb/api_async/models/domain_load_balancer_quotas.py +++ b/koyeb/api_async/models/domain_load_balancer_quotas.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/domain_status.py b/koyeb/api_async/models/domain_status.py index 8abb49ab..a3565275 100644 --- a/koyeb/api_async/models/domain_status.py +++ b/koyeb/api_async/models/domain_status.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/domain_type.py b/koyeb/api_async/models/domain_type.py index 2a709294..573ae4c4 100644 --- a/koyeb/api_async/models/domain_type.py +++ b/koyeb/api_async/models/domain_type.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/domains_summary.py b/koyeb/api_async/models/domains_summary.py index 98b06194..f990be40 100644 --- a/koyeb/api_async/models/domains_summary.py +++ b/koyeb/api_async/models/domains_summary.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/egress_policy.py b/koyeb/api_async/models/egress_policy.py index 72cdc770..4d500f0d 100644 --- a/koyeb/api_async/models/egress_policy.py +++ b/koyeb/api_async/models/egress_policy.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/egress_policy_mode.py b/koyeb/api_async/models/egress_policy_mode.py index 968dc260..9b65aae1 100644 --- a/koyeb/api_async/models/egress_policy_mode.py +++ b/koyeb/api_async/models/egress_policy_mode.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/env.py b/koyeb/api_async/models/env.py index cee7b64a..ebf36e7c 100644 --- a/koyeb/api_async/models/env.py +++ b/koyeb/api_async/models/env.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/error.py b/koyeb/api_async/models/error.py index ec2fe905..81a90a3c 100644 --- a/koyeb/api_async/models/error.py +++ b/koyeb/api_async/models/error.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/error_field.py b/koyeb/api_async/models/error_field.py index 848aca13..94d6b0b7 100644 --- a/koyeb/api_async/models/error_field.py +++ b/koyeb/api_async/models/error_field.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/error_with_fields.py b/koyeb/api_async/models/error_with_fields.py index a4cb8029..426dac64 100644 --- a/koyeb/api_async/models/error_with_fields.py +++ b/koyeb/api_async/models/error_with_fields.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/exec_command_io.py b/koyeb/api_async/models/exec_command_io.py index 1db0c6f7..d8a0a351 100644 --- a/koyeb/api_async/models/exec_command_io.py +++ b/koyeb/api_async/models/exec_command_io.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/exec_command_reply.py b/koyeb/api_async/models/exec_command_reply.py index e069b84f..b19d8535 100644 --- a/koyeb/api_async/models/exec_command_reply.py +++ b/koyeb/api_async/models/exec_command_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/exec_command_request_body.py b/koyeb/api_async/models/exec_command_request_body.py index 876310e0..8e1c809e 100644 --- a/koyeb/api_async/models/exec_command_request_body.py +++ b/koyeb/api_async/models/exec_command_request_body.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/exec_command_request_id_type.py b/koyeb/api_async/models/exec_command_request_id_type.py index f6deb51f..d9074d71 100644 --- a/koyeb/api_async/models/exec_command_request_id_type.py +++ b/koyeb/api_async/models/exec_command_request_id_type.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/exec_command_request_terminal_size.py b/koyeb/api_async/models/exec_command_request_terminal_size.py index 5f6f41ff..3ca721f4 100644 --- a/koyeb/api_async/models/exec_command_request_terminal_size.py +++ b/koyeb/api_async/models/exec_command_request_terminal_size.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/gcp_container_registry_configuration.py b/koyeb/api_async/models/gcp_container_registry_configuration.py index 527bf173..951a8c6c 100644 --- a/koyeb/api_async/models/gcp_container_registry_configuration.py +++ b/koyeb/api_async/models/gcp_container_registry_configuration.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/get_app_reply.py b/koyeb/api_async/models/get_app_reply.py index 2525140f..67ff3a1a 100644 --- a/koyeb/api_async/models/get_app_reply.py +++ b/koyeb/api_async/models/get_app_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/get_archive_reply.py b/koyeb/api_async/models/get_archive_reply.py new file mode 100644 index 00000000..c35bc7e4 --- /dev/null +++ b/koyeb/api_async/models/get_archive_reply.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from koyeb.api_async.models.archive import Archive +from typing import Optional, Set +from typing_extensions import Self +from pydantic_core import to_jsonable_python + + +class GetArchiveReply(BaseModel): + """ + GetArchiveReply + """ # noqa: E501 + + archive: Optional[Archive] = None + __properties: ClassVar[List[str]] = ["archive"] + + model_config = ConfigDict( + validate_by_name=True, + validate_by_alias=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(to_jsonable_python(self.to_dict())) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of GetArchiveReply from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of archive + if self.archive: + _dict["archive"] = self.archive.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of GetArchiveReply from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "archive": Archive.from_dict(obj["archive"]) + if obj.get("archive") is not None + else None + } + ) + return _obj diff --git a/koyeb/api_async/models/get_budget_reply.py b/koyeb/api_async/models/get_budget_reply.py index 1967a425..8b13afca 100644 --- a/koyeb/api_async/models/get_budget_reply.py +++ b/koyeb/api_async/models/get_budget_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/get_catalog_instance_reply.py b/koyeb/api_async/models/get_catalog_instance_reply.py index 0b389eb6..e92c9622 100644 --- a/koyeb/api_async/models/get_catalog_instance_reply.py +++ b/koyeb/api_async/models/get_catalog_instance_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/get_credential_reply.py b/koyeb/api_async/models/get_credential_reply.py index 0bbbae35..3aa30700 100644 --- a/koyeb/api_async/models/get_credential_reply.py +++ b/koyeb/api_async/models/get_credential_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/get_deployment_reply.py b/koyeb/api_async/models/get_deployment_reply.py index 74eeefb3..e4eca24e 100644 --- a/koyeb/api_async/models/get_deployment_reply.py +++ b/koyeb/api_async/models/get_deployment_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/get_deployment_scaling_reply.py b/koyeb/api_async/models/get_deployment_scaling_reply.py index 959cd562..86d7354c 100644 --- a/koyeb/api_async/models/get_deployment_scaling_reply.py +++ b/koyeb/api_async/models/get_deployment_scaling_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/get_deployment_scaling_reply_item.py b/koyeb/api_async/models/get_deployment_scaling_reply_item.py index 62b90f50..3716e111 100644 --- a/koyeb/api_async/models/get_deployment_scaling_reply_item.py +++ b/koyeb/api_async/models/get_deployment_scaling_reply_item.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/get_domain_reply.py b/koyeb/api_async/models/get_domain_reply.py index d12d5a87..62bc72e8 100644 --- a/koyeb/api_async/models/get_domain_reply.py +++ b/koyeb/api_async/models/get_domain_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/get_github_installation_reply.py b/koyeb/api_async/models/get_github_installation_reply.py index 5777a33a..f18a1b2d 100644 --- a/koyeb/api_async/models/get_github_installation_reply.py +++ b/koyeb/api_async/models/get_github_installation_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/get_idenfy_token_reply.py b/koyeb/api_async/models/get_idenfy_token_reply.py index fe8ac94e..9fce4b99 100644 --- a/koyeb/api_async/models/get_idenfy_token_reply.py +++ b/koyeb/api_async/models/get_idenfy_token_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/get_instance_reply.py b/koyeb/api_async/models/get_instance_reply.py index 565f7eab..ef93d12f 100644 --- a/koyeb/api_async/models/get_instance_reply.py +++ b/koyeb/api_async/models/get_instance_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/get_instance_snapshot_reply.py b/koyeb/api_async/models/get_instance_snapshot_reply.py index 96f45713..ce442652 100644 --- a/koyeb/api_async/models/get_instance_snapshot_reply.py +++ b/koyeb/api_async/models/get_instance_snapshot_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/get_intercom_profile_reply.py b/koyeb/api_async/models/get_intercom_profile_reply.py index 1fad5419..22356241 100644 --- a/koyeb/api_async/models/get_intercom_profile_reply.py +++ b/koyeb/api_async/models/get_intercom_profile_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/get_metrics_reply.py b/koyeb/api_async/models/get_metrics_reply.py index 82fb030a..6cdde167 100644 --- a/koyeb/api_async/models/get_metrics_reply.py +++ b/koyeb/api_async/models/get_metrics_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/get_metrics_reply_metric.py b/koyeb/api_async/models/get_metrics_reply_metric.py index 91296d33..e27d9b4d 100644 --- a/koyeb/api_async/models/get_metrics_reply_metric.py +++ b/koyeb/api_async/models/get_metrics_reply_metric.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/get_o_auth_options_reply.py b/koyeb/api_async/models/get_o_auth_options_reply.py index eaa6a7fb..9186758a 100644 --- a/koyeb/api_async/models/get_o_auth_options_reply.py +++ b/koyeb/api_async/models/get_o_auth_options_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/get_organization_invitation_reply.py b/koyeb/api_async/models/get_organization_invitation_reply.py index effe9295..ddc64218 100644 --- a/koyeb/api_async/models/get_organization_invitation_reply.py +++ b/koyeb/api_async/models/get_organization_invitation_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/get_organization_quotas_usage_reply.py b/koyeb/api_async/models/get_organization_quotas_usage_reply.py index 34b137ec..d800b11e 100644 --- a/koyeb/api_async/models/get_organization_quotas_usage_reply.py +++ b/koyeb/api_async/models/get_organization_quotas_usage_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/get_organization_reply.py b/koyeb/api_async/models/get_organization_reply.py index a0f820e7..a917ae57 100644 --- a/koyeb/api_async/models/get_organization_reply.py +++ b/koyeb/api_async/models/get_organization_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/get_organization_summary_reply.py b/koyeb/api_async/models/get_organization_summary_reply.py index 0f874337..9d25eb61 100644 --- a/koyeb/api_async/models/get_organization_summary_reply.py +++ b/koyeb/api_async/models/get_organization_summary_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/get_organization_usage_details_reply.py b/koyeb/api_async/models/get_organization_usage_details_reply.py index 7026df73..e4a3b8b9 100644 --- a/koyeb/api_async/models/get_organization_usage_details_reply.py +++ b/koyeb/api_async/models/get_organization_usage_details_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/get_organization_usage_reply.py b/koyeb/api_async/models/get_organization_usage_reply.py index d613d068..9da9def8 100644 --- a/koyeb/api_async/models/get_organization_usage_reply.py +++ b/koyeb/api_async/models/get_organization_usage_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/get_payment_method_reply.py b/koyeb/api_async/models/get_payment_method_reply.py index f890b7b2..43452cff 100644 --- a/koyeb/api_async/models/get_payment_method_reply.py +++ b/koyeb/api_async/models/get_payment_method_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/get_persistent_volume_reply.py b/koyeb/api_async/models/get_persistent_volume_reply.py index cf00c000..b6393ae8 100644 --- a/koyeb/api_async/models/get_persistent_volume_reply.py +++ b/koyeb/api_async/models/get_persistent_volume_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/get_pool_claim_reply.py b/koyeb/api_async/models/get_pool_claim_reply.py index 8298e451..923aba27 100644 --- a/koyeb/api_async/models/get_pool_claim_reply.py +++ b/koyeb/api_async/models/get_pool_claim_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/get_project_reply.py b/koyeb/api_async/models/get_project_reply.py index abbbb7a3..41033264 100644 --- a/koyeb/api_async/models/get_project_reply.py +++ b/koyeb/api_async/models/get_project_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/get_quotas_reply.py b/koyeb/api_async/models/get_quotas_reply.py index 449ac119..afbb16dc 100644 --- a/koyeb/api_async/models/get_quotas_reply.py +++ b/koyeb/api_async/models/get_quotas_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/get_region_reply.py b/koyeb/api_async/models/get_region_reply.py index da25649d..e09450a3 100644 --- a/koyeb/api_async/models/get_region_reply.py +++ b/koyeb/api_async/models/get_region_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/get_regional_deployment_reply.py b/koyeb/api_async/models/get_regional_deployment_reply.py index 250cf655..f5ad7352 100644 --- a/koyeb/api_async/models/get_regional_deployment_reply.py +++ b/koyeb/api_async/models/get_regional_deployment_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/get_secret_reply.py b/koyeb/api_async/models/get_secret_reply.py index f79355ed..edc2e34c 100644 --- a/koyeb/api_async/models/get_secret_reply.py +++ b/koyeb/api_async/models/get_secret_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/get_service_pool_reply.py b/koyeb/api_async/models/get_service_pool_reply.py index 685cb1e5..39c14b80 100644 --- a/koyeb/api_async/models/get_service_pool_reply.py +++ b/koyeb/api_async/models/get_service_pool_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/get_service_reply.py b/koyeb/api_async/models/get_service_reply.py index 412d5691..bcb0c809 100644 --- a/koyeb/api_async/models/get_service_reply.py +++ b/koyeb/api_async/models/get_service_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/get_service_scaling_reply.py b/koyeb/api_async/models/get_service_scaling_reply.py index d916d9ca..d6aa75e2 100644 --- a/koyeb/api_async/models/get_service_scaling_reply.py +++ b/koyeb/api_async/models/get_service_scaling_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/get_snapshot_reply.py b/koyeb/api_async/models/get_snapshot_reply.py index ee195518..2524a8f2 100644 --- a/koyeb/api_async/models/get_snapshot_reply.py +++ b/koyeb/api_async/models/get_snapshot_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/get_subscription_reply.py b/koyeb/api_async/models/get_subscription_reply.py index d0f23615..09ec8ad4 100644 --- a/koyeb/api_async/models/get_subscription_reply.py +++ b/koyeb/api_async/models/get_subscription_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/get_user_organization_invitation_reply.py b/koyeb/api_async/models/get_user_organization_invitation_reply.py index cc3d4337..ec82fd1e 100644 --- a/koyeb/api_async/models/get_user_organization_invitation_reply.py +++ b/koyeb/api_async/models/get_user_organization_invitation_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/get_user_settings_reply.py b/koyeb/api_async/models/get_user_settings_reply.py index 590b5733..1e844b34 100644 --- a/koyeb/api_async/models/get_user_settings_reply.py +++ b/koyeb/api_async/models/get_user_settings_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/git_deployment_metadata.py b/koyeb/api_async/models/git_deployment_metadata.py index 251e3423..a0ebd666 100644 --- a/koyeb/api_async/models/git_deployment_metadata.py +++ b/koyeb/api_async/models/git_deployment_metadata.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/git_env_deployment_metadata.py b/koyeb/api_async/models/git_env_deployment_metadata.py index 095fb60f..2b839337 100644 --- a/koyeb/api_async/models/git_env_deployment_metadata.py +++ b/koyeb/api_async/models/git_env_deployment_metadata.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/git_hub_registry_configuration.py b/koyeb/api_async/models/git_hub_registry_configuration.py index 61e5d778..ea87f2e4 100644 --- a/koyeb/api_async/models/git_hub_registry_configuration.py +++ b/koyeb/api_async/models/git_hub_registry_configuration.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/git_lab_registry_configuration.py b/koyeb/api_async/models/git_lab_registry_configuration.py index 656f77bd..37f76535 100644 --- a/koyeb/api_async/models/git_lab_registry_configuration.py +++ b/koyeb/api_async/models/git_lab_registry_configuration.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/git_source.py b/koyeb/api_async/models/git_source.py index dc427807..ecace8dd 100644 --- a/koyeb/api_async/models/git_source.py +++ b/koyeb/api_async/models/git_source.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -48,6 +48,10 @@ class GitSource(BaseModel): default=None, description='Credentials can come from a specific source or default to using Github (when unset or set to "github").', ) + skip_submodules: Optional[StrictBool] = Field( + default=None, + description="A flag to skip initializing git submodules when cloning the repository.", + ) __properties: ClassVar[List[str]] = [ "repository", "branch", @@ -60,6 +64,7 @@ class GitSource(BaseModel): "buildpack", "docker", "credential_source", + "skip_submodules", ] model_config = ConfigDict( @@ -133,6 +138,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("docker") is not None else None, "credential_source": obj.get("credential_source"), + "skip_submodules": obj.get("skip_submodules"), } ) return _obj diff --git a/koyeb/api_async/models/github_installation_reply.py b/koyeb/api_async/models/github_installation_reply.py index 7ff07785..c88570a9 100644 --- a/koyeb/api_async/models/github_installation_reply.py +++ b/koyeb/api_async/models/github_installation_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/github_installation_request.py b/koyeb/api_async/models/github_installation_request.py index 3fe192b8..c92fe1b0 100644 --- a/koyeb/api_async/models/github_installation_request.py +++ b/koyeb/api_async/models/github_installation_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/google_protobuf_any.py b/koyeb/api_async/models/google_protobuf_any.py index 43c57cab..df4e60a4 100644 --- a/koyeb/api_async/models/google_protobuf_any.py +++ b/koyeb/api_async/models/google_protobuf_any.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/google_protobuf_null_value.py b/koyeb/api_async/models/google_protobuf_null_value.py index 0245ec31..ef88559c 100644 --- a/koyeb/api_async/models/google_protobuf_null_value.py +++ b/koyeb/api_async/models/google_protobuf_null_value.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/google_rpc_status.py b/koyeb/api_async/models/google_rpc_status.py index dba242c8..4ca05a07 100644 --- a/koyeb/api_async/models/google_rpc_status.py +++ b/koyeb/api_async/models/google_rpc_status.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/grpc_health_check.py b/koyeb/api_async/models/grpc_health_check.py index 8471078b..3caac80e 100644 --- a/koyeb/api_async/models/grpc_health_check.py +++ b/koyeb/api_async/models/grpc_health_check.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/has_unpaid_invoices_reply.py b/koyeb/api_async/models/has_unpaid_invoices_reply.py index d474ea9e..0da1663d 100644 --- a/koyeb/api_async/models/has_unpaid_invoices_reply.py +++ b/koyeb/api_async/models/has_unpaid_invoices_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/http_header.py b/koyeb/api_async/models/http_header.py index b6525c46..4eed0257 100644 --- a/koyeb/api_async/models/http_header.py +++ b/koyeb/api_async/models/http_header.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/http_health_check.py b/koyeb/api_async/models/http_health_check.py index 4630275e..2fb277c4 100644 --- a/koyeb/api_async/models/http_health_check.py +++ b/koyeb/api_async/models/http_health_check.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/instance.py b/koyeb/api_async/models/instance.py index 7dfa47db..bb3c9315 100644 --- a/koyeb/api_async/models/instance.py +++ b/koyeb/api_async/models/instance.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/instance_availability.py b/koyeb/api_async/models/instance_availability.py index e1b86137..a887ea3e 100644 --- a/koyeb/api_async/models/instance_availability.py +++ b/koyeb/api_async/models/instance_availability.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/instance_event.py b/koyeb/api_async/models/instance_event.py index 0723d3e4..f74af4c8 100644 --- a/koyeb/api_async/models/instance_event.py +++ b/koyeb/api_async/models/instance_event.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/instance_list_item.py b/koyeb/api_async/models/instance_list_item.py index bca2ef6c..b141afbd 100644 --- a/koyeb/api_async/models/instance_list_item.py +++ b/koyeb/api_async/models/instance_list_item.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/instance_snapshot.py b/koyeb/api_async/models/instance_snapshot.py index e1804def..aee38693 100644 --- a/koyeb/api_async/models/instance_snapshot.py +++ b/koyeb/api_async/models/instance_snapshot.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/instance_snapshot_event.py b/koyeb/api_async/models/instance_snapshot_event.py index 3973c87b..98dbdfe5 100644 --- a/koyeb/api_async/models/instance_snapshot_event.py +++ b/koyeb/api_async/models/instance_snapshot_event.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/instance_snapshot_quotas.py b/koyeb/api_async/models/instance_snapshot_quotas.py index 9345e32e..b5fa63f0 100644 --- a/koyeb/api_async/models/instance_snapshot_quotas.py +++ b/koyeb/api_async/models/instance_snapshot_quotas.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/instance_snapshot_status.py b/koyeb/api_async/models/instance_snapshot_status.py index 7bf4c276..a7b121e9 100644 --- a/koyeb/api_async/models/instance_snapshot_status.py +++ b/koyeb/api_async/models/instance_snapshot_status.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/instance_snapshot_type.py b/koyeb/api_async/models/instance_snapshot_type.py index ed2af447..e472ea5e 100644 --- a/koyeb/api_async/models/instance_snapshot_type.py +++ b/koyeb/api_async/models/instance_snapshot_type.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/instance_snapshot_type_usage.py b/koyeb/api_async/models/instance_snapshot_type_usage.py index 7196bed6..59624b09 100644 --- a/koyeb/api_async/models/instance_snapshot_type_usage.py +++ b/koyeb/api_async/models/instance_snapshot_type_usage.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/instance_status.py b/koyeb/api_async/models/instance_status.py index b55bc490..45c2b19b 100644 --- a/koyeb/api_async/models/instance_status.py +++ b/koyeb/api_async/models/instance_status.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/instance_type_usage.py b/koyeb/api_async/models/instance_type_usage.py index 7b6f923c..d5b0d30e 100644 --- a/koyeb/api_async/models/instance_type_usage.py +++ b/koyeb/api_async/models/instance_type_usage.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/instance_usage.py b/koyeb/api_async/models/instance_usage.py index b2e50393..91d66173 100644 --- a/koyeb/api_async/models/instance_usage.py +++ b/koyeb/api_async/models/instance_usage.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/instances_summary.py b/koyeb/api_async/models/instances_summary.py index 2fd3a99e..00723bd0 100644 --- a/koyeb/api_async/models/instances_summary.py +++ b/koyeb/api_async/models/instances_summary.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/invite_user_request.py b/koyeb/api_async/models/invite_user_request.py index b216f397..eb11a5c4 100644 --- a/koyeb/api_async/models/invite_user_request.py +++ b/koyeb/api_async/models/invite_user_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/kgitproxy_branch.py b/koyeb/api_async/models/kgitproxy_branch.py index 379a03c1..56884107 100644 --- a/koyeb/api_async/models/kgitproxy_branch.py +++ b/koyeb/api_async/models/kgitproxy_branch.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/kgitproxy_git_hub_repository.py b/koyeb/api_async/models/kgitproxy_git_hub_repository.py index 3b6a4603..8a79d712 100644 --- a/koyeb/api_async/models/kgitproxy_git_hub_repository.py +++ b/koyeb/api_async/models/kgitproxy_git_hub_repository.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/kgitproxy_github_installation_status.py b/koyeb/api_async/models/kgitproxy_github_installation_status.py index b2644fec..794c3ec1 100644 --- a/koyeb/api_async/models/kgitproxy_github_installation_status.py +++ b/koyeb/api_async/models/kgitproxy_github_installation_status.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/kgitproxy_indexing_status.py b/koyeb/api_async/models/kgitproxy_indexing_status.py index e10b3041..871478e0 100644 --- a/koyeb/api_async/models/kgitproxy_indexing_status.py +++ b/koyeb/api_async/models/kgitproxy_indexing_status.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/kgitproxy_list_branches_reply.py b/koyeb/api_async/models/kgitproxy_list_branches_reply.py index 5def6fa0..2e32e04b 100644 --- a/koyeb/api_async/models/kgitproxy_list_branches_reply.py +++ b/koyeb/api_async/models/kgitproxy_list_branches_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/kgitproxy_list_repositories_reply.py b/koyeb/api_async/models/kgitproxy_list_repositories_reply.py index 1fa35557..20b65d19 100644 --- a/koyeb/api_async/models/kgitproxy_list_repositories_reply.py +++ b/koyeb/api_async/models/kgitproxy_list_repositories_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/kgitproxy_repository.py b/koyeb/api_async/models/kgitproxy_repository.py index c8ba063a..bd04d55d 100644 --- a/koyeb/api_async/models/kgitproxy_repository.py +++ b/koyeb/api_async/models/kgitproxy_repository.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/kgitproxy_repository_provider.py b/koyeb/api_async/models/kgitproxy_repository_provider.py index 0f639dec..f9364e88 100644 --- a/koyeb/api_async/models/kgitproxy_repository_provider.py +++ b/koyeb/api_async/models/kgitproxy_repository_provider.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/kmeta_get_organization_workspace_quotas_reply.py b/koyeb/api_async/models/kmeta_get_organization_workspace_quotas_reply.py new file mode 100644 index 00000000..84b43f2f --- /dev/null +++ b/koyeb/api_async/models/kmeta_get_organization_workspace_quotas_reply.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from koyeb.api_async.models.quotas import Quotas +from typing import Optional, Set +from typing_extensions import Self +from pydantic_core import to_jsonable_python + + +class KmetaGetOrganizationWorkspaceQuotasReply(BaseModel): + """ + KmetaGetOrganizationWorkspaceQuotasReply + """ # noqa: E501 + + quotas: Optional[Quotas] = None + __properties: ClassVar[List[str]] = ["quotas"] + + model_config = ConfigDict( + validate_by_name=True, + validate_by_alias=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(to_jsonable_python(self.to_dict())) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of KmetaGetOrganizationWorkspaceQuotasReply from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of quotas + if self.quotas: + _dict["quotas"] = self.quotas.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of KmetaGetOrganizationWorkspaceQuotasReply from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "quotas": Quotas.from_dict(obj["quotas"]) + if obj.get("quotas") is not None + else None + } + ) + return _obj diff --git a/koyeb/api_async/models/ksearch_app.py b/koyeb/api_async/models/ksearch_app.py index 35177b2b..fdd8a208 100644 --- a/koyeb/api_async/models/ksearch_app.py +++ b/koyeb/api_async/models/ksearch_app.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/ksearch_global_deployment.py b/koyeb/api_async/models/ksearch_global_deployment.py index a073ba07..ca4372c8 100644 --- a/koyeb/api_async/models/ksearch_global_deployment.py +++ b/koyeb/api_async/models/ksearch_global_deployment.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/ksearch_instance.py b/koyeb/api_async/models/ksearch_instance.py index d7b0de96..c7525a6a 100644 --- a/koyeb/api_async/models/ksearch_instance.py +++ b/koyeb/api_async/models/ksearch_instance.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/ksearch_organization.py b/koyeb/api_async/models/ksearch_organization.py index c9e27c77..240ad0d0 100644 --- a/koyeb/api_async/models/ksearch_organization.py +++ b/koyeb/api_async/models/ksearch_organization.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/ksearch_regional_deployment.py b/koyeb/api_async/models/ksearch_regional_deployment.py index b18825e5..3429e7ed 100644 --- a/koyeb/api_async/models/ksearch_regional_deployment.py +++ b/koyeb/api_async/models/ksearch_regional_deployment.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/ksearch_search_reply.py b/koyeb/api_async/models/ksearch_search_reply.py index 48d97769..a43f5845 100644 --- a/koyeb/api_async/models/ksearch_search_reply.py +++ b/koyeb/api_async/models/ksearch_search_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/ksearch_service.py b/koyeb/api_async/models/ksearch_service.py index b7dfc5b8..28e4dabe 100644 --- a/koyeb/api_async/models/ksearch_service.py +++ b/koyeb/api_async/models/ksearch_service.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/ksearch_user.py b/koyeb/api_async/models/ksearch_user.py index cdff67c0..9734c413 100644 --- a/koyeb/api_async/models/ksearch_user.py +++ b/koyeb/api_async/models/ksearch_user.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/ktest_test_auth_reply.py b/koyeb/api_async/models/ktest_test_auth_reply.py index 7f6559d5..dd3ced88 100644 --- a/koyeb/api_async/models/ktest_test_auth_reply.py +++ b/koyeb/api_async/models/ktest_test_auth_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/ktest_test_auth_request.py b/koyeb/api_async/models/ktest_test_auth_request.py index 2900650b..fe6b6d99 100644 --- a/koyeb/api_async/models/ktest_test_auth_request.py +++ b/koyeb/api_async/models/ktest_test_auth_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/lifecycle_quotas.py b/koyeb/api_async/models/lifecycle_quotas.py index bc027411..2f1d1a0b 100644 --- a/koyeb/api_async/models/lifecycle_quotas.py +++ b/koyeb/api_async/models/lifecycle_quotas.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/list_app_events_reply.py b/koyeb/api_async/models/list_app_events_reply.py index 0523f7c4..fda4bf47 100644 --- a/koyeb/api_async/models/list_app_events_reply.py +++ b/koyeb/api_async/models/list_app_events_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/list_apps_reply.py b/koyeb/api_async/models/list_apps_reply.py index ed558355..6a7a035d 100644 --- a/koyeb/api_async/models/list_apps_reply.py +++ b/koyeb/api_async/models/list_apps_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/list_archives_reply.py b/koyeb/api_async/models/list_archives_reply.py new file mode 100644 index 00000000..a95e8151 --- /dev/null +++ b/koyeb/api_async/models/list_archives_reply.py @@ -0,0 +1,113 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictBool, StrictInt +from typing import Any, ClassVar, Dict, List, Optional +from koyeb.api_async.models.archive import Archive +from typing import Optional, Set +from typing_extensions import Self +from pydantic_core import to_jsonable_python + + +class ListArchivesReply(BaseModel): + """ + ListArchivesReply + """ # noqa: E501 + + archives: Optional[List[Archive]] = None + limit: Optional[StrictInt] = None + offset: Optional[StrictInt] = None + count: Optional[StrictInt] = None + has_next: Optional[StrictBool] = None + __properties: ClassVar[List[str]] = [ + "archives", + "limit", + "offset", + "count", + "has_next", + ] + + model_config = ConfigDict( + validate_by_name=True, + validate_by_alias=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(to_jsonable_python(self.to_dict())) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ListArchivesReply from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in archives (list) + _items = [] + if self.archives: + for _item_archives in self.archives: + _items.append( + _item_archives.to_dict() if _item_archives is not None else None + ) + _dict["archives"] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ListArchivesReply from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "archives": [Archive.from_dict(_item) for _item in obj["archives"]] + if obj.get("archives") is not None + else None, + "limit": obj.get("limit"), + "offset": obj.get("offset"), + "count": obj.get("count"), + "has_next": obj.get("has_next"), + } + ) + return _obj diff --git a/koyeb/api_async/models/list_catalog_instances_reply.py b/koyeb/api_async/models/list_catalog_instances_reply.py index 3c077fee..c3c0687a 100644 --- a/koyeb/api_async/models/list_catalog_instances_reply.py +++ b/koyeb/api_async/models/list_catalog_instances_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/list_credentials_reply.py b/koyeb/api_async/models/list_credentials_reply.py index 1a49d44b..c4f62bf0 100644 --- a/koyeb/api_async/models/list_credentials_reply.py +++ b/koyeb/api_async/models/list_credentials_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/list_datacenters_reply.py b/koyeb/api_async/models/list_datacenters_reply.py index e5c24974..b119b373 100644 --- a/koyeb/api_async/models/list_datacenters_reply.py +++ b/koyeb/api_async/models/list_datacenters_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/list_deployment_events_reply.py b/koyeb/api_async/models/list_deployment_events_reply.py index c02a3839..8b1811a6 100644 --- a/koyeb/api_async/models/list_deployment_events_reply.py +++ b/koyeb/api_async/models/list_deployment_events_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/list_deployments_reply.py b/koyeb/api_async/models/list_deployments_reply.py index 8d3bfcfd..8b89fbd3 100644 --- a/koyeb/api_async/models/list_deployments_reply.py +++ b/koyeb/api_async/models/list_deployments_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/list_domains_reply.py b/koyeb/api_async/models/list_domains_reply.py index 2e3022fa..b2da8b84 100644 --- a/koyeb/api_async/models/list_domains_reply.py +++ b/koyeb/api_async/models/list_domains_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/list_instance_events_reply.py b/koyeb/api_async/models/list_instance_events_reply.py index 61f23c6e..26fc33ef 100644 --- a/koyeb/api_async/models/list_instance_events_reply.py +++ b/koyeb/api_async/models/list_instance_events_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/list_instance_snapshot_events_reply.py b/koyeb/api_async/models/list_instance_snapshot_events_reply.py index fe39332d..718f38f6 100644 --- a/koyeb/api_async/models/list_instance_snapshot_events_reply.py +++ b/koyeb/api_async/models/list_instance_snapshot_events_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/list_instance_snapshots_reply.py b/koyeb/api_async/models/list_instance_snapshots_reply.py index a887f46c..aaccb6c1 100644 --- a/koyeb/api_async/models/list_instance_snapshots_reply.py +++ b/koyeb/api_async/models/list_instance_snapshots_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/list_instances_reply.py b/koyeb/api_async/models/list_instances_reply.py index 340e74cd..ff51d115 100644 --- a/koyeb/api_async/models/list_instances_reply.py +++ b/koyeb/api_async/models/list_instances_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/list_organization_invitations_reply.py b/koyeb/api_async/models/list_organization_invitations_reply.py index 57edbff7..e9f22e83 100644 --- a/koyeb/api_async/models/list_organization_invitations_reply.py +++ b/koyeb/api_async/models/list_organization_invitations_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/list_organization_members_reply.py b/koyeb/api_async/models/list_organization_members_reply.py index d19304a7..7c56c777 100644 --- a/koyeb/api_async/models/list_organization_members_reply.py +++ b/koyeb/api_async/models/list_organization_members_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/list_payment_methods_reply.py b/koyeb/api_async/models/list_payment_methods_reply.py index 13473f6e..16289acf 100644 --- a/koyeb/api_async/models/list_payment_methods_reply.py +++ b/koyeb/api_async/models/list_payment_methods_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/list_persistent_volume_events_reply.py b/koyeb/api_async/models/list_persistent_volume_events_reply.py index febbe7b9..5957cb1a 100644 --- a/koyeb/api_async/models/list_persistent_volume_events_reply.py +++ b/koyeb/api_async/models/list_persistent_volume_events_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/list_persistent_volumes_reply.py b/koyeb/api_async/models/list_persistent_volumes_reply.py index 8367c279..40e1fb04 100644 --- a/koyeb/api_async/models/list_persistent_volumes_reply.py +++ b/koyeb/api_async/models/list_persistent_volumes_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/list_pool_claim_reply.py b/koyeb/api_async/models/list_pool_claim_reply.py index f329b193..751d45eb 100644 --- a/koyeb/api_async/models/list_pool_claim_reply.py +++ b/koyeb/api_async/models/list_pool_claim_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/list_projects_reply.py b/koyeb/api_async/models/list_projects_reply.py index 4257a6d3..cdeb0183 100644 --- a/koyeb/api_async/models/list_projects_reply.py +++ b/koyeb/api_async/models/list_projects_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/list_regional_deployment_events_reply.py b/koyeb/api_async/models/list_regional_deployment_events_reply.py index b231ed37..3fecc203 100644 --- a/koyeb/api_async/models/list_regional_deployment_events_reply.py +++ b/koyeb/api_async/models/list_regional_deployment_events_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/list_regional_deployments_reply.py b/koyeb/api_async/models/list_regional_deployments_reply.py index 9dc49ee8..1d8f15b0 100644 --- a/koyeb/api_async/models/list_regional_deployments_reply.py +++ b/koyeb/api_async/models/list_regional_deployments_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/list_regions_reply.py b/koyeb/api_async/models/list_regions_reply.py index 15ed2f2d..681b6d09 100644 --- a/koyeb/api_async/models/list_regions_reply.py +++ b/koyeb/api_async/models/list_regions_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/list_secrets_reply.py b/koyeb/api_async/models/list_secrets_reply.py index 4c6bbd9a..ddec23f9 100644 --- a/koyeb/api_async/models/list_secrets_reply.py +++ b/koyeb/api_async/models/list_secrets_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/list_service_events_reply.py b/koyeb/api_async/models/list_service_events_reply.py index 0d491f5b..dff25569 100644 --- a/koyeb/api_async/models/list_service_events_reply.py +++ b/koyeb/api_async/models/list_service_events_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/list_service_pools_reply.py b/koyeb/api_async/models/list_service_pools_reply.py index 4d10fb8f..ab4e31e4 100644 --- a/koyeb/api_async/models/list_service_pools_reply.py +++ b/koyeb/api_async/models/list_service_pools_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/list_services_reply.py b/koyeb/api_async/models/list_services_reply.py index 2e728e73..1aa09c95 100644 --- a/koyeb/api_async/models/list_services_reply.py +++ b/koyeb/api_async/models/list_services_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/list_snapshots_reply.py b/koyeb/api_async/models/list_snapshots_reply.py index 5d45a4d2..675e2598 100644 --- a/koyeb/api_async/models/list_snapshots_reply.py +++ b/koyeb/api_async/models/list_snapshots_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/list_usage_reply.py b/koyeb/api_async/models/list_usage_reply.py index 2e8bd9eb..05043cc4 100644 --- a/koyeb/api_async/models/list_usage_reply.py +++ b/koyeb/api_async/models/list_usage_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/list_user_organization_invitations_reply.py b/koyeb/api_async/models/list_user_organization_invitations_reply.py index 85c7cce7..0bc4f0ad 100644 --- a/koyeb/api_async/models/list_user_organization_invitations_reply.py +++ b/koyeb/api_async/models/list_user_organization_invitations_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/list_user_organizations_reply.py b/koyeb/api_async/models/list_user_organizations_reply.py index 66aacb72..172571df 100644 --- a/koyeb/api_async/models/list_user_organizations_reply.py +++ b/koyeb/api_async/models/list_user_organizations_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/log_entry.py b/koyeb/api_async/models/log_entry.py index 36b567ed..6162148f 100644 --- a/koyeb/api_async/models/log_entry.py +++ b/koyeb/api_async/models/log_entry.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/login_method_reply.py b/koyeb/api_async/models/login_method_reply.py index abf205b6..566bffaf 100644 --- a/koyeb/api_async/models/login_method_reply.py +++ b/koyeb/api_async/models/login_method_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/login_method_reply_method.py b/koyeb/api_async/models/login_method_reply_method.py index c8eccaa8..c09a1bbe 100644 --- a/koyeb/api_async/models/login_method_reply_method.py +++ b/koyeb/api_async/models/login_method_reply_method.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/login_reply.py b/koyeb/api_async/models/login_reply.py index c6156926..0efd99a5 100644 --- a/koyeb/api_async/models/login_reply.py +++ b/koyeb/api_async/models/login_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/login_request.py b/koyeb/api_async/models/login_request.py index e8631098..0e1884f7 100644 --- a/koyeb/api_async/models/login_request.py +++ b/koyeb/api_async/models/login_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/manage_reply.py b/koyeb/api_async/models/manage_reply.py index 8a63ecb1..9707e2ff 100644 --- a/koyeb/api_async/models/manage_reply.py +++ b/koyeb/api_async/models/manage_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/manual_service_scaling.py b/koyeb/api_async/models/manual_service_scaling.py index b66c1504..d0dbeb23 100644 --- a/koyeb/api_async/models/manual_service_scaling.py +++ b/koyeb/api_async/models/manual_service_scaling.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/members_summary.py b/koyeb/api_async/models/members_summary.py index 7f8a146e..b36f70d9 100644 --- a/koyeb/api_async/models/members_summary.py +++ b/koyeb/api_async/models/members_summary.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/mesh.py b/koyeb/api_async/models/mesh.py index 69e08f88..f1c5fa02 100644 --- a/koyeb/api_async/models/mesh.py +++ b/koyeb/api_async/models/mesh.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/mesh_scope.py b/koyeb/api_async/models/mesh_scope.py index 09c58074..ce5884bb 100644 --- a/koyeb/api_async/models/mesh_scope.py +++ b/koyeb/api_async/models/mesh_scope.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/metric_name.py b/koyeb/api_async/models/metric_name.py index 04fe8f9c..74be0500 100644 --- a/koyeb/api_async/models/metric_name.py +++ b/koyeb/api_async/models/metric_name.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/neon_postgres_database.py b/koyeb/api_async/models/neon_postgres_database.py index 4efa531f..5cb8ed7b 100644 --- a/koyeb/api_async/models/neon_postgres_database.py +++ b/koyeb/api_async/models/neon_postgres_database.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/neon_postgres_database_deployment_metadata.py b/koyeb/api_async/models/neon_postgres_database_deployment_metadata.py index 8319b37b..0a5efb00 100644 --- a/koyeb/api_async/models/neon_postgres_database_deployment_metadata.py +++ b/koyeb/api_async/models/neon_postgres_database_deployment_metadata.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/neon_postgres_database_neon_database.py b/koyeb/api_async/models/neon_postgres_database_neon_database.py index 92ee9a8d..09b9f803 100644 --- a/koyeb/api_async/models/neon_postgres_database_neon_database.py +++ b/koyeb/api_async/models/neon_postgres_database_neon_database.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/neon_postgres_database_neon_role.py b/koyeb/api_async/models/neon_postgres_database_neon_role.py index 197ccfca..bed5f1b2 100644 --- a/koyeb/api_async/models/neon_postgres_database_neon_role.py +++ b/koyeb/api_async/models/neon_postgres_database_neon_role.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/neon_postgres_summary.py b/koyeb/api_async/models/neon_postgres_summary.py index 1498922b..345a047e 100644 --- a/koyeb/api_async/models/neon_postgres_summary.py +++ b/koyeb/api_async/models/neon_postgres_summary.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/network_policy.py b/koyeb/api_async/models/network_policy.py index 3a4264b0..e9ccb59c 100644 --- a/koyeb/api_async/models/network_policy.py +++ b/koyeb/api_async/models/network_policy.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/network_policy_destination.py b/koyeb/api_async/models/network_policy_destination.py index 74819999..314ca13a 100644 --- a/koyeb/api_async/models/network_policy_destination.py +++ b/koyeb/api_async/models/network_policy_destination.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/next_invoice_reply.py b/koyeb/api_async/models/next_invoice_reply.py index cb612bcd..3e973a6c 100644 --- a/koyeb/api_async/models/next_invoice_reply.py +++ b/koyeb/api_async/models/next_invoice_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/next_invoice_reply_discount.py b/koyeb/api_async/models/next_invoice_reply_discount.py index bb75d9a5..7f1aaf71 100644 --- a/koyeb/api_async/models/next_invoice_reply_discount.py +++ b/koyeb/api_async/models/next_invoice_reply_discount.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/next_invoice_reply_discount_type.py b/koyeb/api_async/models/next_invoice_reply_discount_type.py index 1e4d17b9..ccddd6c0 100644 --- a/koyeb/api_async/models/next_invoice_reply_discount_type.py +++ b/koyeb/api_async/models/next_invoice_reply_discount_type.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/next_invoice_reply_line.py b/koyeb/api_async/models/next_invoice_reply_line.py index 6599f3d1..e5aef9ca 100644 --- a/koyeb/api_async/models/next_invoice_reply_line.py +++ b/koyeb/api_async/models/next_invoice_reply_line.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/next_invoice_reply_line_period.py b/koyeb/api_async/models/next_invoice_reply_line_period.py index 2ab5705c..5cf6471b 100644 --- a/koyeb/api_async/models/next_invoice_reply_line_period.py +++ b/koyeb/api_async/models/next_invoice_reply_line_period.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/next_invoice_reply_line_price.py b/koyeb/api_async/models/next_invoice_reply_line_price.py index f63eab5a..dc47bd90 100644 --- a/koyeb/api_async/models/next_invoice_reply_line_price.py +++ b/koyeb/api_async/models/next_invoice_reply_line_price.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/notification.py b/koyeb/api_async/models/notification.py index b51fca1b..38bdfb2d 100644 --- a/koyeb/api_async/models/notification.py +++ b/koyeb/api_async/models/notification.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/notification_list.py b/koyeb/api_async/models/notification_list.py index 39f76de1..3010404a 100644 --- a/koyeb/api_async/models/notification_list.py +++ b/koyeb/api_async/models/notification_list.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/o_auth_callback_reply.py b/koyeb/api_async/models/o_auth_callback_reply.py index 78b81071..e88a0530 100644 --- a/koyeb/api_async/models/o_auth_callback_reply.py +++ b/koyeb/api_async/models/o_auth_callback_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/o_auth_callback_request.py b/koyeb/api_async/models/o_auth_callback_request.py index 62512cc5..0cf319eb 100644 --- a/koyeb/api_async/models/o_auth_callback_request.py +++ b/koyeb/api_async/models/o_auth_callback_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/o_auth_provider.py b/koyeb/api_async/models/o_auth_provider.py index 62da2980..487e69f7 100644 --- a/koyeb/api_async/models/o_auth_provider.py +++ b/koyeb/api_async/models/o_auth_provider.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/object.py b/koyeb/api_async/models/object.py index ae4edf2a..42532267 100644 --- a/koyeb/api_async/models/object.py +++ b/koyeb/api_async/models/object.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/organization.py b/koyeb/api_async/models/organization.py index bf99cde9..ec5ad2a7 100644 --- a/koyeb/api_async/models/organization.py +++ b/koyeb/api_async/models/organization.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/organization_deactivation_reason.py b/koyeb/api_async/models/organization_deactivation_reason.py index be4ea25b..4a40d3b6 100644 --- a/koyeb/api_async/models/organization_deactivation_reason.py +++ b/koyeb/api_async/models/organization_deactivation_reason.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/organization_detailed_status.py b/koyeb/api_async/models/organization_detailed_status.py index 97152a5a..b289793d 100644 --- a/koyeb/api_async/models/organization_detailed_status.py +++ b/koyeb/api_async/models/organization_detailed_status.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/organization_invitation.py b/koyeb/api_async/models/organization_invitation.py index 19cc9b79..8ed339e6 100644 --- a/koyeb/api_async/models/organization_invitation.py +++ b/koyeb/api_async/models/organization_invitation.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/organization_invitation_status.py b/koyeb/api_async/models/organization_invitation_status.py index 79b188ac..455a5dc4 100644 --- a/koyeb/api_async/models/organization_invitation_status.py +++ b/koyeb/api_async/models/organization_invitation_status.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/organization_member.py b/koyeb/api_async/models/organization_member.py index d4442177..48f6dd45 100644 --- a/koyeb/api_async/models/organization_member.py +++ b/koyeb/api_async/models/organization_member.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/organization_member_status.py b/koyeb/api_async/models/organization_member_status.py index a3c3dfcf..67fde6b7 100644 --- a/koyeb/api_async/models/organization_member_status.py +++ b/koyeb/api_async/models/organization_member_status.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/organization_status.py b/koyeb/api_async/models/organization_status.py index 7b71ec15..5a643ac7 100644 --- a/koyeb/api_async/models/organization_status.py +++ b/koyeb/api_async/models/organization_status.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/organization_summary.py b/koyeb/api_async/models/organization_summary.py index b1fb8922..1c14f2e6 100644 --- a/koyeb/api_async/models/organization_summary.py +++ b/koyeb/api_async/models/organization_summary.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/payment_method.py b/koyeb/api_async/models/payment_method.py index 9b642ad0..31c77b69 100644 --- a/koyeb/api_async/models/payment_method.py +++ b/koyeb/api_async/models/payment_method.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/payment_method_status.py b/koyeb/api_async/models/payment_method_status.py index 23137302..e334a42d 100644 --- a/koyeb/api_async/models/payment_method_status.py +++ b/koyeb/api_async/models/payment_method_status.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/period_usage.py b/koyeb/api_async/models/period_usage.py index 0138089f..b3656c03 100644 --- a/koyeb/api_async/models/period_usage.py +++ b/koyeb/api_async/models/period_usage.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/persistent_volume.py b/koyeb/api_async/models/persistent_volume.py index ffb08ed2..7f784d2d 100644 --- a/koyeb/api_async/models/persistent_volume.py +++ b/koyeb/api_async/models/persistent_volume.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/persistent_volume_backing_store.py b/koyeb/api_async/models/persistent_volume_backing_store.py index b0b52db9..080ab099 100644 --- a/koyeb/api_async/models/persistent_volume_backing_store.py +++ b/koyeb/api_async/models/persistent_volume_backing_store.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/persistent_volume_event.py b/koyeb/api_async/models/persistent_volume_event.py index f04abe91..ca723db1 100644 --- a/koyeb/api_async/models/persistent_volume_event.py +++ b/koyeb/api_async/models/persistent_volume_event.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/persistent_volume_quotas.py b/koyeb/api_async/models/persistent_volume_quotas.py index d250f912..5838f1ca 100644 --- a/koyeb/api_async/models/persistent_volume_quotas.py +++ b/koyeb/api_async/models/persistent_volume_quotas.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/persistent_volume_region_usage.py b/koyeb/api_async/models/persistent_volume_region_usage.py index 11ec76f7..f5ced990 100644 --- a/koyeb/api_async/models/persistent_volume_region_usage.py +++ b/koyeb/api_async/models/persistent_volume_region_usage.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/persistent_volume_status.py b/koyeb/api_async/models/persistent_volume_status.py index 3ad575e0..3c2e44b7 100644 --- a/koyeb/api_async/models/persistent_volume_status.py +++ b/koyeb/api_async/models/persistent_volume_status.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/plan.py b/koyeb/api_async/models/plan.py index 08b1384e..afc5fdb9 100644 --- a/koyeb/api_async/models/plan.py +++ b/koyeb/api_async/models/plan.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/pool_claim.py b/koyeb/api_async/models/pool_claim.py index eeca02b3..6f8de6ca 100644 --- a/koyeb/api_async/models/pool_claim.py +++ b/koyeb/api_async/models/pool_claim.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -38,10 +38,8 @@ class PoolClaim(BaseModel): status: Optional[PoolClaimStatus] = PoolClaimStatus.UNSPECIFIED organization_id: Optional[StrictStr] = None workspace_id: Optional[StrictStr] = None - customer_id: Optional[StrictStr] = None created_at: Optional[datetime] = None fulfilled_at: Optional[datetime] = None - released_at: Optional[datetime] = None pool_generation: Optional[StrictStr] = None __properties: ClassVar[List[str]] = [ "id", @@ -51,10 +49,8 @@ class PoolClaim(BaseModel): "status", "organization_id", "workspace_id", - "customer_id", "created_at", "fulfilled_at", - "released_at", "pool_generation", ] @@ -117,10 +113,8 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: else PoolClaimStatus.UNSPECIFIED, "organization_id": obj.get("organization_id"), "workspace_id": obj.get("workspace_id"), - "customer_id": obj.get("customer_id"), "created_at": obj.get("created_at"), "fulfilled_at": obj.get("fulfilled_at"), - "released_at": obj.get("released_at"), "pool_generation": obj.get("pool_generation"), } ) diff --git a/koyeb/api_async/models/pool_claim_reply.py b/koyeb/api_async/models/pool_claim_reply.py index 208ec011..5278f432 100644 --- a/koyeb/api_async/models/pool_claim_reply.py +++ b/koyeb/api_async/models/pool_claim_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/pool_claim_request.py b/koyeb/api_async/models/pool_claim_request.py index 9d2968cb..ad501e32 100644 --- a/koyeb/api_async/models/pool_claim_request.py +++ b/koyeb/api_async/models/pool_claim_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -17,7 +17,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List, Optional from typing import Optional, Set from typing_extensions import Self @@ -30,7 +30,10 @@ class PoolClaimRequest(BaseModel): """ # noqa: E501 pool_id: Optional[StrictStr] = None - request_id: Optional[StrictStr] = None + request_id: Optional[StrictStr] = Field( + default=None, + description="Idempotency key scoped to the pool: retries with the same value return the same claim. A fresh id is generated when omitted.", + ) __properties: ClassVar[List[str]] = ["pool_id", "request_id"] model_config = ConfigDict( diff --git a/koyeb/api_async/models/pool_claim_status.py b/koyeb/api_async/models/pool_claim_status.py index b05f69b1..1b6c07d9 100644 --- a/koyeb/api_async/models/pool_claim_status.py +++ b/koyeb/api_async/models/pool_claim_status.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -30,7 +30,6 @@ class PoolClaimStatus(str, Enum): PENDING = "PENDING" FULFILLED = "FULFILLED" FAILED = "FAILED" - RELEASED = "RELEASED" @classmethod def from_json(cls, json_str: str) -> Self: diff --git a/koyeb/api_async/models/port.py b/koyeb/api_async/models/port.py index 6c990f5a..a66edd1a 100644 --- a/koyeb/api_async/models/port.py +++ b/koyeb/api_async/models/port.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/private_registry_configuration.py b/koyeb/api_async/models/private_registry_configuration.py index 029aa86b..aafedac2 100644 --- a/koyeb/api_async/models/private_registry_configuration.py +++ b/koyeb/api_async/models/private_registry_configuration.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/project.py b/koyeb/api_async/models/project.py index 2b0db6f3..0f9f286a 100644 --- a/koyeb/api_async/models/project.py +++ b/koyeb/api_async/models/project.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/proxy_port_protocol.py b/koyeb/api_async/models/proxy_port_protocol.py index 886bb3bc..4666ec21 100644 --- a/koyeb/api_async/models/proxy_port_protocol.py +++ b/koyeb/api_async/models/proxy_port_protocol.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/public_organization.py b/koyeb/api_async/models/public_organization.py index dc325f71..bb0efd50 100644 --- a/koyeb/api_async/models/public_organization.py +++ b/koyeb/api_async/models/public_organization.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/public_user.py b/koyeb/api_async/models/public_user.py index 7cc3859e..e473879a 100644 --- a/koyeb/api_async/models/public_user.py +++ b/koyeb/api_async/models/public_user.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/query_logs_reply.py b/koyeb/api_async/models/query_logs_reply.py index 6d2b6ddd..e744a18e 100644 --- a/koyeb/api_async/models/query_logs_reply.py +++ b/koyeb/api_async/models/query_logs_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/query_logs_reply_pagination.py b/koyeb/api_async/models/query_logs_reply_pagination.py index 3c478605..aa0a330e 100644 --- a/koyeb/api_async/models/query_logs_reply_pagination.py +++ b/koyeb/api_async/models/query_logs_reply_pagination.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/query_services_view_filters.py b/koyeb/api_async/models/query_services_view_filters.py new file mode 100644 index 00000000..b1b90b21 --- /dev/null +++ b/koyeb/api_async/models/query_services_view_filters.py @@ -0,0 +1,116 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from koyeb.api_async.models.service_status import ServiceStatus +from koyeb.api_async.models.service_type import ServiceType +from koyeb.api_async.models.service_view_active_deployment_state import ( + ServiceViewActiveDeploymentState, +) +from koyeb.api_async.models.service_view_latest_deployment_state import ( + ServiceViewLatestDeploymentState, +) +from typing import Optional, Set +from typing_extensions import Self +from pydantic_core import to_jsonable_python + + +class QueryServicesViewFilters(BaseModel): + """ + QueryServicesViewFilters + """ # noqa: E501 + + types: Optional[List[ServiceType]] = None + statuses: Optional[List[ServiceStatus]] = None + regions: Optional[List[StrictStr]] = None + app_ids: Optional[List[StrictStr]] = None + active_deployment_states: Optional[List[ServiceViewActiveDeploymentState]] = None + latest_deployment_states: Optional[List[ServiceViewLatestDeploymentState]] = None + needs_attention: Optional[StrictBool] = None + __properties: ClassVar[List[str]] = [ + "types", + "statuses", + "regions", + "app_ids", + "active_deployment_states", + "latest_deployment_states", + "needs_attention", + ] + + model_config = ConfigDict( + validate_by_name=True, + validate_by_alias=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(to_jsonable_python(self.to_dict())) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of QueryServicesViewFilters from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of QueryServicesViewFilters from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "types": obj.get("types"), + "statuses": obj.get("statuses"), + "regions": obj.get("regions"), + "app_ids": obj.get("app_ids"), + "active_deployment_states": obj.get("active_deployment_states"), + "latest_deployment_states": obj.get("latest_deployment_states"), + "needs_attention": obj.get("needs_attention"), + } + ) + return _obj diff --git a/koyeb/api_async/models/query_services_view_reply.py b/koyeb/api_async/models/query_services_view_reply.py new file mode 100644 index 00000000..720ecfd7 --- /dev/null +++ b/koyeb/api_async/models/query_services_view_reply.py @@ -0,0 +1,143 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictBool, StrictInt +from typing import Any, ClassVar, Dict, List, Optional +from koyeb.api_async.models.service_view_facet import ServiceViewFacet +from koyeb.api_async.models.service_view_group import ServiceViewGroup +from koyeb.api_async.models.service_view_row import ServiceViewRow +from typing import Optional, Set +from typing_extensions import Self +from pydantic_core import to_jsonable_python + + +class QueryServicesViewReply(BaseModel): + """ + QueryServicesViewReply + """ # noqa: E501 + + services: Optional[List[ServiceViewRow]] = None + groups: Optional[List[ServiceViewGroup]] = None + facets: Optional[List[ServiceViewFacet]] = None + limit: Optional[StrictInt] = None + offset: Optional[StrictInt] = None + count: Optional[StrictInt] = None + has_next: Optional[StrictBool] = None + __properties: ClassVar[List[str]] = [ + "services", + "groups", + "facets", + "limit", + "offset", + "count", + "has_next", + ] + + model_config = ConfigDict( + validate_by_name=True, + validate_by_alias=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(to_jsonable_python(self.to_dict())) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of QueryServicesViewReply from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in services (list) + _items = [] + if self.services: + for _item_services in self.services: + _items.append( + _item_services.to_dict() if _item_services is not None else None + ) + _dict["services"] = _items + # override the default output from pydantic by calling `to_dict()` of each item in groups (list) + _items = [] + if self.groups: + for _item_groups in self.groups: + _items.append( + _item_groups.to_dict() if _item_groups is not None else None + ) + _dict["groups"] = _items + # override the default output from pydantic by calling `to_dict()` of each item in facets (list) + _items = [] + if self.facets: + for _item_facets in self.facets: + _items.append( + _item_facets.to_dict() if _item_facets is not None else None + ) + _dict["facets"] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of QueryServicesViewReply from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "services": [ + ServiceViewRow.from_dict(_item) for _item in obj["services"] + ] + if obj.get("services") is not None + else None, + "groups": [ServiceViewGroup.from_dict(_item) for _item in obj["groups"]] + if obj.get("groups") is not None + else None, + "facets": [ServiceViewFacet.from_dict(_item) for _item in obj["facets"]] + if obj.get("facets") is not None + else None, + "limit": obj.get("limit"), + "offset": obj.get("offset"), + "count": obj.get("count"), + "has_next": obj.get("has_next"), + } + ) + return _obj diff --git a/koyeb/api_async/models/query_services_view_sort.py b/koyeb/api_async/models/query_services_view_sort.py new file mode 100644 index 00000000..cff52a34 --- /dev/null +++ b/koyeb/api_async/models/query_services_view_sort.py @@ -0,0 +1,104 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from koyeb.api_async.models.query_services_view_sort_direction import ( + QueryServicesViewSortDirection, +) +from koyeb.api_async.models.query_services_view_sort_field import ( + QueryServicesViewSortField, +) +from typing import Optional, Set +from typing_extensions import Self +from pydantic_core import to_jsonable_python + + +class QueryServicesViewSort(BaseModel): + """ + QueryServicesViewSort + """ # noqa: E501 + + var_field: Optional[QueryServicesViewSortField] = Field( + default=QueryServicesViewSortField.CREATED_AT, alias="field" + ) + direction: Optional[ + QueryServicesViewSortDirection + ] = QueryServicesViewSortDirection.ASC + __properties: ClassVar[List[str]] = ["field", "direction"] + + model_config = ConfigDict( + validate_by_name=True, + validate_by_alias=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(to_jsonable_python(self.to_dict())) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of QueryServicesViewSort from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of QueryServicesViewSort from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "field": obj.get("field") + if obj.get("field") is not None + else QueryServicesViewSortField.CREATED_AT, + "direction": obj.get("direction") + if obj.get("direction") is not None + else QueryServicesViewSortDirection.ASC, + } + ) + return _obj diff --git a/koyeb/api_async/models/query_services_view_sort_direction.py b/koyeb/api_async/models/query_services_view_sort_direction.py new file mode 100644 index 00000000..c43eb9c5 --- /dev/null +++ b/koyeb/api_async/models/query_services_view_sort_direction.py @@ -0,0 +1,35 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class QueryServicesViewSortDirection(str, Enum): + """ + QueryServicesViewSortDirection + """ + + """ + allowed enum values + """ + ASC = "ASC" + DESC = "DESC" + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of QueryServicesViewSortDirection from a JSON string""" + return cls(json.loads(json_str)) diff --git a/koyeb/api_async/models/query_services_view_sort_field.py b/koyeb/api_async/models/query_services_view_sort_field.py new file mode 100644 index 00000000..d642b8f2 --- /dev/null +++ b/koyeb/api_async/models/query_services_view_sort_field.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class QueryServicesViewSortField(str, Enum): + """ + QueryServicesViewSortField + """ + + """ + allowed enum values + """ + CREATED_AT = "CREATED_AT" + UPDATED_AT = "UPDATED_AT" + NAME = "NAME" + APP_NAME = "APP_NAME" + ACTIVE_DEPLOYMENT_STATE = "ACTIVE_DEPLOYMENT_STATE" + LATEST_DEPLOYMENT_STATE = "LATEST_DEPLOYMENT_STATE" + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of QueryServicesViewSortField from a JSON string""" + return cls(json.loads(json_str)) diff --git a/koyeb/api_async/models/quota_usage.py b/koyeb/api_async/models/quota_usage.py index b32926f2..4930c341 100644 --- a/koyeb/api_async/models/quota_usage.py +++ b/koyeb/api_async/models/quota_usage.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/quotas.py b/koyeb/api_async/models/quotas.py index accb9553..445a70cb 100644 --- a/koyeb/api_async/models/quotas.py +++ b/koyeb/api_async/models/quotas.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -17,7 +17,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, StrictInt, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional from koyeb.api_async.models.domain_load_balancer_quotas import DomainLoadBalancerQuotas from koyeb.api_async.models.instance_snapshot_quotas import InstanceSnapshotQuotas @@ -56,6 +56,10 @@ class Quotas(BaseModel): lifecycle: Optional[LifecycleQuotas] = None max_projects: Optional[StrictStr] = None instance_snapshots: Optional[InstanceSnapshotQuotas] = None + persistent_volumes_disabled: Optional[StrictBool] = Field( + default=None, + description='When true, persistent volumes are disabled for the organization regardless of persistent_volumes_by_region. kaccount\'s ComputeQuotas omits persistent_volumes_by_region when this is set, so the flag must travel explicitly — otherwise consumers cannot distinguish "disabled" from "no custom quotas".', + ) __properties: ClassVar[List[str]] = [ "apps", "services", @@ -79,6 +83,7 @@ class Quotas(BaseModel): "lifecycle", "max_projects", "instance_snapshots", + "persistent_volumes_disabled", ] model_config = ConfigDict( @@ -199,6 +204,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: ) if obj.get("instance_snapshots") is not None else None, + "persistent_volumes_disabled": obj.get("persistent_volumes_disabled"), } ) return _obj diff --git a/koyeb/api_async/models/reactivate_organization_reply.py b/koyeb/api_async/models/reactivate_organization_reply.py index c1a5034e..769ecbf7 100644 --- a/koyeb/api_async/models/reactivate_organization_reply.py +++ b/koyeb/api_async/models/reactivate_organization_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/redeem_coupon_request.py b/koyeb/api_async/models/redeem_coupon_request.py index 724890fd..f111b6e8 100644 --- a/koyeb/api_async/models/redeem_coupon_request.py +++ b/koyeb/api_async/models/redeem_coupon_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/redeploy_reply.py b/koyeb/api_async/models/redeploy_reply.py index 1f2d5527..33814024 100644 --- a/koyeb/api_async/models/redeploy_reply.py +++ b/koyeb/api_async/models/redeploy_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/redeploy_request_info.py b/koyeb/api_async/models/redeploy_request_info.py index 6889b0c3..f92c3eab 100644 --- a/koyeb/api_async/models/redeploy_request_info.py +++ b/koyeb/api_async/models/redeploy_request_info.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/region.py b/koyeb/api_async/models/region.py index da918102..4817edfa 100644 --- a/koyeb/api_async/models/region.py +++ b/koyeb/api_async/models/region.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/region_availability.py b/koyeb/api_async/models/region_availability.py index 0c965c28..6a81d9cf 100644 --- a/koyeb/api_async/models/region_availability.py +++ b/koyeb/api_async/models/region_availability.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/region_list_item.py b/koyeb/api_async/models/region_list_item.py index fc808a2f..5aad8ab9 100644 --- a/koyeb/api_async/models/region_list_item.py +++ b/koyeb/api_async/models/region_list_item.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/region_usage.py b/koyeb/api_async/models/region_usage.py index b7374c7f..0bc9d902 100644 --- a/koyeb/api_async/models/region_usage.py +++ b/koyeb/api_async/models/region_usage.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/regional_deployment.py b/koyeb/api_async/models/regional_deployment.py index 252bce75..d73c6630 100644 --- a/koyeb/api_async/models/regional_deployment.py +++ b/koyeb/api_async/models/regional_deployment.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/regional_deployment_definition.py b/koyeb/api_async/models/regional_deployment_definition.py index 88cc9589..d709d45e 100644 --- a/koyeb/api_async/models/regional_deployment_definition.py +++ b/koyeb/api_async/models/regional_deployment_definition.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -17,7 +17,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, StrictBool, StrictStr +from pydantic import BaseModel, ConfigDict, StrictBool, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional from koyeb.api_async.models.archive_source import ArchiveSource from koyeb.api_async.models.config_file import ConfigFile @@ -65,6 +65,7 @@ class RegionalDeploymentDefinition(BaseModel): RegionalDeploymentMesh ] = RegionalDeploymentMesh.REGIONAL_DEPLOYMENT_MESH_AUTO network_policy: Optional[NetworkPolicy] = None + kill_timeout_secs: Optional[StrictInt] = None docker: Optional[DockerSource] = None git: Optional[GitSource] = None archive: Optional[ArchiveSource] = None @@ -85,6 +86,7 @@ class RegionalDeploymentDefinition(BaseModel): "skip_cache", "mesh", "network_policy", + "kill_timeout_secs", "docker", "git", "archive", @@ -254,6 +256,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "network_policy": NetworkPolicy.from_dict(obj["network_policy"]) if obj.get("network_policy") is not None else None, + "kill_timeout_secs": obj.get("kill_timeout_secs"), "docker": DockerSource.from_dict(obj["docker"]) if obj.get("docker") is not None else None, diff --git a/koyeb/api_async/models/regional_deployment_definition_type.py b/koyeb/api_async/models/regional_deployment_definition_type.py index cf99a593..2b38fdb3 100644 --- a/koyeb/api_async/models/regional_deployment_definition_type.py +++ b/koyeb/api_async/models/regional_deployment_definition_type.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/regional_deployment_event.py b/koyeb/api_async/models/regional_deployment_event.py index 0d1c6dec..95c6f3bd 100644 --- a/koyeb/api_async/models/regional_deployment_event.py +++ b/koyeb/api_async/models/regional_deployment_event.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/regional_deployment_list_item.py b/koyeb/api_async/models/regional_deployment_list_item.py index 908cd4f6..b883da38 100644 --- a/koyeb/api_async/models/regional_deployment_list_item.py +++ b/koyeb/api_async/models/regional_deployment_list_item.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/regional_deployment_mesh.py b/koyeb/api_async/models/regional_deployment_mesh.py index 2a819434..1c49a0ed 100644 --- a/koyeb/api_async/models/regional_deployment_mesh.py +++ b/koyeb/api_async/models/regional_deployment_mesh.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/regional_deployment_metadata.py b/koyeb/api_async/models/regional_deployment_metadata.py index cd2e05c0..a8578895 100644 --- a/koyeb/api_async/models/regional_deployment_metadata.py +++ b/koyeb/api_async/models/regional_deployment_metadata.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/regional_deployment_role.py b/koyeb/api_async/models/regional_deployment_role.py index 92908b22..b7352c77 100644 --- a/koyeb/api_async/models/regional_deployment_role.py +++ b/koyeb/api_async/models/regional_deployment_role.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/regional_deployment_status.py b/koyeb/api_async/models/regional_deployment_status.py index 7b21b754..11544241 100644 --- a/koyeb/api_async/models/regional_deployment_status.py +++ b/koyeb/api_async/models/regional_deployment_status.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/regional_deployment_volume.py b/koyeb/api_async/models/regional_deployment_volume.py index 0758da9e..3951cf1a 100644 --- a/koyeb/api_async/models/regional_deployment_volume.py +++ b/koyeb/api_async/models/regional_deployment_volume.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/remove_organization_member_reply.py b/koyeb/api_async/models/remove_organization_member_reply.py index 4d5600d5..a12aa65a 100644 --- a/koyeb/api_async/models/remove_organization_member_reply.py +++ b/koyeb/api_async/models/remove_organization_member_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/resend_organization_invitation_reply.py b/koyeb/api_async/models/resend_organization_invitation_reply.py index fffa6b21..29ee1edb 100644 --- a/koyeb/api_async/models/resend_organization_invitation_reply.py +++ b/koyeb/api_async/models/resend_organization_invitation_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/reset_password_request.py b/koyeb/api_async/models/reset_password_request.py index 911dd4a1..97382cf9 100644 --- a/koyeb/api_async/models/reset_password_request.py +++ b/koyeb/api_async/models/reset_password_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/reveal_secret_reply.py b/koyeb/api_async/models/reveal_secret_reply.py index de3b4836..c95349f8 100644 --- a/koyeb/api_async/models/reveal_secret_reply.py +++ b/koyeb/api_async/models/reveal_secret_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/review_organization_capacity_reply.py b/koyeb/api_async/models/review_organization_capacity_reply.py index ffce029e..e21217e7 100644 --- a/koyeb/api_async/models/review_organization_capacity_reply.py +++ b/koyeb/api_async/models/review_organization_capacity_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/review_organization_capacity_request.py b/koyeb/api_async/models/review_organization_capacity_request.py index accb33be..91030bd3 100644 --- a/koyeb/api_async/models/review_organization_capacity_request.py +++ b/koyeb/api_async/models/review_organization_capacity_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/route.py b/koyeb/api_async/models/route.py index 23efe0b0..e79016a4 100644 --- a/koyeb/api_async/models/route.py +++ b/koyeb/api_async/models/route.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/sample.py b/koyeb/api_async/models/sample.py index a462263c..2b4b8b02 100644 --- a/koyeb/api_async/models/sample.py +++ b/koyeb/api_async/models/sample.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/sandbox_metadata.py b/koyeb/api_async/models/sandbox_metadata.py index 3868167c..6b8d0d1a 100644 --- a/koyeb/api_async/models/sandbox_metadata.py +++ b/koyeb/api_async/models/sandbox_metadata.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -31,7 +31,8 @@ class SandboxMetadata(BaseModel): public_url: Optional[StrictStr] = None routing_key: Optional[StrictStr] = None - __properties: ClassVar[List[str]] = ["public_url", "routing_key"] + internal_url: Optional[StrictStr] = None + __properties: ClassVar[List[str]] = ["public_url", "routing_key", "internal_url"] model_config = ConfigDict( validate_by_name=True, @@ -82,6 +83,10 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: return cls.model_validate(obj) _obj = cls.model_validate( - {"public_url": obj.get("public_url"), "routing_key": obj.get("routing_key")} + { + "public_url": obj.get("public_url"), + "routing_key": obj.get("routing_key"), + "internal_url": obj.get("internal_url"), + } ) return _obj diff --git a/koyeb/api_async/models/scale_to_zero_quotas.py b/koyeb/api_async/models/scale_to_zero_quotas.py index afe4e3d7..2c48aa72 100644 --- a/koyeb/api_async/models/scale_to_zero_quotas.py +++ b/koyeb/api_async/models/scale_to_zero_quotas.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/scaling.py b/koyeb/api_async/models/scaling.py index 6aaaf565..3b3e38d0 100644 --- a/koyeb/api_async/models/scaling.py +++ b/koyeb/api_async/models/scaling.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/secret.py b/koyeb/api_async/models/secret.py index 11d054e6..a84c1072 100644 --- a/koyeb/api_async/models/secret.py +++ b/koyeb/api_async/models/secret.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/secret_type.py b/koyeb/api_async/models/secret_type.py index d58e874a..43528ab0 100644 --- a/koyeb/api_async/models/secret_type.py +++ b/koyeb/api_async/models/secret_type.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/secrets_summary.py b/koyeb/api_async/models/secrets_summary.py index c9ebbe40..5d435c62 100644 --- a/koyeb/api_async/models/secrets_summary.py +++ b/koyeb/api_async/models/secrets_summary.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/security_policies.py b/koyeb/api_async/models/security_policies.py index 0ad1f95d..8ae339b4 100644 --- a/koyeb/api_async/models/security_policies.py +++ b/koyeb/api_async/models/security_policies.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/service.py b/koyeb/api_async/models/service.py index da189219..57793edf 100644 --- a/koyeb/api_async/models/service.py +++ b/koyeb/api_async/models/service.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/service_event.py b/koyeb/api_async/models/service_event.py index 5146ee01..0c07ad87 100644 --- a/koyeb/api_async/models/service_event.py +++ b/koyeb/api_async/models/service_event.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/service_life_cycle.py b/koyeb/api_async/models/service_life_cycle.py index bcec37e4..b5017cfc 100644 --- a/koyeb/api_async/models/service_life_cycle.py +++ b/koyeb/api_async/models/service_life_cycle.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/service_list_item.py b/koyeb/api_async/models/service_list_item.py index 033a4f2b..50524aab 100644 --- a/koyeb/api_async/models/service_list_item.py +++ b/koyeb/api_async/models/service_list_item.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/service_pool.py b/koyeb/api_async/models/service_pool.py index f4a63daf..4fee1c8f 100644 --- a/koyeb/api_async/models/service_pool.py +++ b/koyeb/api_async/models/service_pool.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -44,7 +44,6 @@ class ServicePool(BaseModel): status: Optional[ServicePoolStatus] = ServicePoolStatus.UNSPECIFIED messages: Optional[List[StrictStr]] = None generation: Optional[StrictStr] = None - customer_id: Optional[StrictStr] = None __properties: ClassVar[List[str]] = [ "id", "created_at", @@ -58,7 +57,6 @@ class ServicePool(BaseModel): "status", "messages", "generation", - "customer_id", ] model_config = ConfigDict( @@ -130,7 +128,6 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: else ServicePoolStatus.UNSPECIFIED, "messages": obj.get("messages"), "generation": obj.get("generation"), - "customer_id": obj.get("customer_id"), } ) return _obj diff --git a/koyeb/api_async/models/service_pool_status.py b/koyeb/api_async/models/service_pool_status.py index fd5a03dc..1e5101c9 100644 --- a/koyeb/api_async/models/service_pool_status.py +++ b/koyeb/api_async/models/service_pool_status.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/service_state.py b/koyeb/api_async/models/service_state.py index 7f1d6e8a..d01a9c6e 100644 --- a/koyeb/api_async/models/service_state.py +++ b/koyeb/api_async/models/service_state.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/service_status.py b/koyeb/api_async/models/service_status.py index 2fde4c67..1bcc18d8 100644 --- a/koyeb/api_async/models/service_status.py +++ b/koyeb/api_async/models/service_status.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/service_summary.py b/koyeb/api_async/models/service_summary.py index 8c661d03..9e1cb66f 100644 --- a/koyeb/api_async/models/service_summary.py +++ b/koyeb/api_async/models/service_summary.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/service_type.py b/koyeb/api_async/models/service_type.py index 7f839c5b..2679dd3f 100644 --- a/koyeb/api_async/models/service_type.py +++ b/koyeb/api_async/models/service_type.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/service_usage.py b/koyeb/api_async/models/service_usage.py index 39dfb07f..4b33b118 100644 --- a/koyeb/api_async/models/service_usage.py +++ b/koyeb/api_async/models/service_usage.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/service_view_active_deployment.py b/koyeb/api_async/models/service_view_active_deployment.py new file mode 100644 index 00000000..bcd1a2ba --- /dev/null +++ b/koyeb/api_async/models/service_view_active_deployment.py @@ -0,0 +1,116 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from koyeb.api_async.models.deployment_status import DeploymentStatus +from koyeb.api_async.models.service_view_active_deployment_state import ( + ServiceViewActiveDeploymentState, +) +from typing import Optional, Set +from typing_extensions import Self +from pydantic_core import to_jsonable_python + + +class ServiceViewActiveDeployment(BaseModel): + """ + ServiceViewActiveDeployment + """ # noqa: E501 + + state: Optional[ + ServiceViewActiveDeploymentState + ] = ServiceViewActiveDeploymentState.NONE + id: Optional[StrictStr] = None + missing: Optional[StrictBool] = None + status: Optional[DeploymentStatus] = DeploymentStatus.PENDING + created_at: Optional[datetime] = None + updated_at: Optional[datetime] = None + __properties: ClassVar[List[str]] = [ + "state", + "id", + "missing", + "status", + "created_at", + "updated_at", + ] + + model_config = ConfigDict( + validate_by_name=True, + validate_by_alias=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(to_jsonable_python(self.to_dict())) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServiceViewActiveDeployment from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServiceViewActiveDeployment from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "state": obj.get("state") + if obj.get("state") is not None + else ServiceViewActiveDeploymentState.NONE, + "id": obj.get("id"), + "missing": obj.get("missing"), + "status": obj.get("status") + if obj.get("status") is not None + else DeploymentStatus.PENDING, + "created_at": obj.get("created_at"), + "updated_at": obj.get("updated_at"), + } + ) + return _obj diff --git a/koyeb/api_async/models/service_view_active_deployment_state.py b/koyeb/api_async/models/service_view_active_deployment_state.py new file mode 100644 index 00000000..40aa5161 --- /dev/null +++ b/koyeb/api_async/models/service_view_active_deployment_state.py @@ -0,0 +1,41 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class ServiceViewActiveDeploymentState(str, Enum): + """ + - SLEEPING: The active Deployment is scaled to zero and wakes up on traffic + """ + + """ + allowed enum values + """ + NONE = "NONE" + STARTING = "STARTING" + HEALTHY = "HEALTHY" + DEGRADED = "DEGRADED" + UNHEALTHY = "UNHEALTHY" + STOPPING = "STOPPING" + PAUSED = "PAUSED" + SLEEPING = "SLEEPING" + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of ServiceViewActiveDeploymentState from a JSON string""" + return cls(json.loads(json_str)) diff --git a/koyeb/api_async/models/service_view_app.py b/koyeb/api_async/models/service_view_app.py new file mode 100644 index 00000000..c6b5ab47 --- /dev/null +++ b/koyeb/api_async/models/service_view_app.py @@ -0,0 +1,85 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self +from pydantic_core import to_jsonable_python + + +class ServiceViewApp(BaseModel): + """ + ServiceViewApp + """ # noqa: E501 + + id: Optional[StrictStr] = None + name: Optional[StrictStr] = None + __properties: ClassVar[List[str]] = ["id", "name"] + + model_config = ConfigDict( + validate_by_name=True, + validate_by_alias=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(to_jsonable_python(self.to_dict())) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServiceViewApp from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServiceViewApp from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({"id": obj.get("id"), "name": obj.get("name")}) + return _obj diff --git a/koyeb/api_async/models/service_view_facet.py b/koyeb/api_async/models/service_view_facet.py new file mode 100644 index 00000000..0e27e3d4 --- /dev/null +++ b/koyeb/api_async/models/service_view_facet.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from koyeb.api_async.models.service_view_facet_kind import ServiceViewFacetKind +from koyeb.api_async.models.service_view_facet_value import ServiceViewFacetValue +from typing import Optional, Set +from typing_extensions import Self +from pydantic_core import to_jsonable_python + + +class ServiceViewFacet(BaseModel): + """ + ServiceViewFacet + """ # noqa: E501 + + kind: Optional[ServiceViewFacetKind] = ServiceViewFacetKind.TYPE + values: Optional[List[ServiceViewFacetValue]] = None + __properties: ClassVar[List[str]] = ["kind", "values"] + + model_config = ConfigDict( + validate_by_name=True, + validate_by_alias=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(to_jsonable_python(self.to_dict())) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServiceViewFacet from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in values (list) + _items = [] + if self.values: + for _item_values in self.values: + _items.append( + _item_values.to_dict() if _item_values is not None else None + ) + _dict["values"] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServiceViewFacet from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "kind": obj.get("kind") + if obj.get("kind") is not None + else ServiceViewFacetKind.TYPE, + "values": [ + ServiceViewFacetValue.from_dict(_item) for _item in obj["values"] + ] + if obj.get("values") is not None + else None, + } + ) + return _obj diff --git a/koyeb/api_async/models/service_view_facet_kind.py b/koyeb/api_async/models/service_view_facet_kind.py new file mode 100644 index 00000000..23ee22d4 --- /dev/null +++ b/koyeb/api_async/models/service_view_facet_kind.py @@ -0,0 +1,40 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class ServiceViewFacetKind(str, Enum): + """ + ServiceViewFacetKind + """ + + """ + allowed enum values + """ + TYPE = "TYPE" + STATUS = "STATUS" + REGION = "REGION" + APP = "APP" + ACTIVE_DEPLOYMENT_STATE = "ACTIVE_DEPLOYMENT_STATE" + LATEST_DEPLOYMENT_STATE = "LATEST_DEPLOYMENT_STATE" + NEEDS_ATTENTION = "NEEDS_ATTENTION" + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of ServiceViewFacetKind from a JSON string""" + return cls(json.loads(json_str)) diff --git a/koyeb/api_async/models/service_view_facet_value.py b/koyeb/api_async/models/service_view_facet_value.py new file mode 100644 index 00000000..60e13797 --- /dev/null +++ b/koyeb/api_async/models/service_view_facet_value.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self +from pydantic_core import to_jsonable_python + + +class ServiceViewFacetValue(BaseModel): + """ + ServiceViewFacetValue + """ # noqa: E501 + + value: Optional[StrictStr] = None + label: Optional[StrictStr] = None + count: Optional[StrictInt] = None + __properties: ClassVar[List[str]] = ["value", "label", "count"] + + model_config = ConfigDict( + validate_by_name=True, + validate_by_alias=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(to_jsonable_python(self.to_dict())) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServiceViewFacetValue from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServiceViewFacetValue from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "value": obj.get("value"), + "label": obj.get("label"), + "count": obj.get("count"), + } + ) + return _obj diff --git a/koyeb/api_async/models/service_view_group.py b/koyeb/api_async/models/service_view_group.py new file mode 100644 index 00000000..58447db4 --- /dev/null +++ b/koyeb/api_async/models/service_view_group.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from koyeb.api_async.models.service_view_group_by import ServiceViewGroupBy +from typing import Optional, Set +from typing_extensions import Self +from pydantic_core import to_jsonable_python + + +class ServiceViewGroup(BaseModel): + """ + ServiceViewGroup + """ # noqa: E501 + + by: Optional[ServiceViewGroupBy] = ServiceViewGroupBy.NO_GROUP + key: Optional[StrictStr] = None + label: Optional[StrictStr] = None + count: Optional[StrictInt] = None + __properties: ClassVar[List[str]] = ["by", "key", "label", "count"] + + model_config = ConfigDict( + validate_by_name=True, + validate_by_alias=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(to_jsonable_python(self.to_dict())) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServiceViewGroup from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServiceViewGroup from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "by": obj.get("by") + if obj.get("by") is not None + else ServiceViewGroupBy.NO_GROUP, + "key": obj.get("key"), + "label": obj.get("label"), + "count": obj.get("count"), + } + ) + return _obj diff --git a/koyeb/api_async/models/service_view_group_by.py b/koyeb/api_async/models/service_view_group_by.py new file mode 100644 index 00000000..bf2ebf31 --- /dev/null +++ b/koyeb/api_async/models/service_view_group_by.py @@ -0,0 +1,35 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class ServiceViewGroupBy(str, Enum): + """ + ServiceViewGroupBy + """ + + """ + allowed enum values + """ + NO_GROUP = "NO_GROUP" + APP = "APP" + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of ServiceViewGroupBy from a JSON string""" + return cls(json.loads(json_str)) diff --git a/koyeb/api_async/models/service_view_latest_deployment.py b/koyeb/api_async/models/service_view_latest_deployment.py new file mode 100644 index 00000000..9553dec9 --- /dev/null +++ b/koyeb/api_async/models/service_view_latest_deployment.py @@ -0,0 +1,116 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from koyeb.api_async.models.deployment_status import DeploymentStatus +from koyeb.api_async.models.service_view_latest_deployment_state import ( + ServiceViewLatestDeploymentState, +) +from typing import Optional, Set +from typing_extensions import Self +from pydantic_core import to_jsonable_python + + +class ServiceViewLatestDeployment(BaseModel): + """ + ServiceViewLatestDeployment + """ # noqa: E501 + + state: Optional[ + ServiceViewLatestDeploymentState + ] = ServiceViewLatestDeploymentState.NONE + id: Optional[StrictStr] = None + missing: Optional[StrictBool] = None + status: Optional[DeploymentStatus] = DeploymentStatus.PENDING + created_at: Optional[datetime] = None + updated_at: Optional[datetime] = None + __properties: ClassVar[List[str]] = [ + "state", + "id", + "missing", + "status", + "created_at", + "updated_at", + ] + + model_config = ConfigDict( + validate_by_name=True, + validate_by_alias=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(to_jsonable_python(self.to_dict())) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServiceViewLatestDeployment from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServiceViewLatestDeployment from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "state": obj.get("state") + if obj.get("state") is not None + else ServiceViewLatestDeploymentState.NONE, + "id": obj.get("id"), + "missing": obj.get("missing"), + "status": obj.get("status") + if obj.get("status") is not None + else DeploymentStatus.PENDING, + "created_at": obj.get("created_at"), + "updated_at": obj.get("updated_at"), + } + ) + return _obj diff --git a/koyeb/api_async/models/service_view_latest_deployment_state.py b/koyeb/api_async/models/service_view_latest_deployment_state.py new file mode 100644 index 00000000..b8af5a35 --- /dev/null +++ b/koyeb/api_async/models/service_view_latest_deployment_state.py @@ -0,0 +1,37 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class ServiceViewLatestDeploymentState(str, Enum): + """ + ServiceViewLatestDeploymentState + """ + + """ + allowed enum values + """ + NONE = "NONE" + STARTING = "STARTING" + STOPPING = "STOPPING" + FAILED = "FAILED" + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of ServiceViewLatestDeploymentState from a JSON string""" + return cls(json.loads(json_str)) diff --git a/koyeb/api_async/models/service_view_row.py b/koyeb/api_async/models/service_view_row.py new file mode 100644 index 00000000..9a11e2b3 --- /dev/null +++ b/koyeb/api_async/models/service_view_row.py @@ -0,0 +1,171 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from koyeb.api_async.models.service_status import ServiceStatus +from koyeb.api_async.models.service_type import ServiceType +from koyeb.api_async.models.service_view_active_deployment import ( + ServiceViewActiveDeployment, +) +from koyeb.api_async.models.service_view_app import ServiceViewApp +from koyeb.api_async.models.service_view_latest_deployment import ( + ServiceViewLatestDeployment, +) +from koyeb.api_async.models.service_view_source import ServiceViewSource +from typing import Optional, Set +from typing_extensions import Self +from pydantic_core import to_jsonable_python + + +class ServiceViewRow(BaseModel): + """ + ServiceViewRow + """ # noqa: E501 + + id: Optional[StrictStr] = None + name: Optional[StrictStr] = None + type: Optional[ServiceType] = ServiceType.INVALID_TYPE + status: Optional[ServiceStatus] = ServiceStatus.STARTING + messages: Optional[List[StrictStr]] = None + created_at: Optional[datetime] = None + updated_at: Optional[datetime] = None + app_id: Optional[StrictStr] = None + app: Optional[ServiceViewApp] = None + active_deployment: Optional[ServiceViewActiveDeployment] = None + latest_deployment: Optional[ServiceViewLatestDeployment] = None + needs_attention: Optional[StrictBool] = None + regions: Optional[List[StrictStr]] = None + instance_type: Optional[StrictStr] = None + source: Optional[ServiceViewSource] = None + __properties: ClassVar[List[str]] = [ + "id", + "name", + "type", + "status", + "messages", + "created_at", + "updated_at", + "app_id", + "app", + "active_deployment", + "latest_deployment", + "needs_attention", + "regions", + "instance_type", + "source", + ] + + model_config = ConfigDict( + validate_by_name=True, + validate_by_alias=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(to_jsonable_python(self.to_dict())) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServiceViewRow from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of app + if self.app: + _dict["app"] = self.app.to_dict() + # override the default output from pydantic by calling `to_dict()` of active_deployment + if self.active_deployment: + _dict["active_deployment"] = self.active_deployment.to_dict() + # override the default output from pydantic by calling `to_dict()` of latest_deployment + if self.latest_deployment: + _dict["latest_deployment"] = self.latest_deployment.to_dict() + # override the default output from pydantic by calling `to_dict()` of source + if self.source: + _dict["source"] = self.source.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServiceViewRow from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "id": obj.get("id"), + "name": obj.get("name"), + "type": obj.get("type") + if obj.get("type") is not None + else ServiceType.INVALID_TYPE, + "status": obj.get("status") + if obj.get("status") is not None + else ServiceStatus.STARTING, + "messages": obj.get("messages"), + "created_at": obj.get("created_at"), + "updated_at": obj.get("updated_at"), + "app_id": obj.get("app_id"), + "app": ServiceViewApp.from_dict(obj["app"]) + if obj.get("app") is not None + else None, + "active_deployment": ServiceViewActiveDeployment.from_dict( + obj["active_deployment"] + ) + if obj.get("active_deployment") is not None + else None, + "latest_deployment": ServiceViewLatestDeployment.from_dict( + obj["latest_deployment"] + ) + if obj.get("latest_deployment") is not None + else None, + "needs_attention": obj.get("needs_attention"), + "regions": obj.get("regions"), + "instance_type": obj.get("instance_type"), + "source": ServiceViewSource.from_dict(obj["source"]) + if obj.get("source") is not None + else None, + } + ) + return _obj diff --git a/koyeb/api_async/models/service_view_source.py b/koyeb/api_async/models/service_view_source.py new file mode 100644 index 00000000..fc7aea8a --- /dev/null +++ b/koyeb/api_async/models/service_view_source.py @@ -0,0 +1,93 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from koyeb.api_async.models.service_view_source_type import ServiceViewSourceType +from typing import Optional, Set +from typing_extensions import Self +from pydantic_core import to_jsonable_python + + +class ServiceViewSource(BaseModel): + """ + ServiceViewSource + """ # noqa: E501 + + type: Optional[ServiceViewSourceType] = ServiceViewSourceType.UNKNOWN + reference: Optional[StrictStr] = None + __properties: ClassVar[List[str]] = ["type", "reference"] + + model_config = ConfigDict( + validate_by_name=True, + validate_by_alias=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + return json.dumps(to_jsonable_python(self.to_dict())) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ServiceViewSource from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ServiceViewSource from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "type": obj.get("type") + if obj.get("type") is not None + else ServiceViewSourceType.UNKNOWN, + "reference": obj.get("reference"), + } + ) + return _obj diff --git a/koyeb/api_async/models/service_view_source_type.py b/koyeb/api_async/models/service_view_source_type.py new file mode 100644 index 00000000..889f6e5a --- /dev/null +++ b/koyeb/api_async/models/service_view_source_type.py @@ -0,0 +1,38 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class ServiceViewSourceType(str, Enum): + """ + ServiceViewSourceType + """ + + """ + allowed enum values + """ + UNKNOWN = "UNKNOWN" + DOCKER = "DOCKER" + GIT = "GIT" + ARCHIVE = "ARCHIVE" + DATABASE = "DATABASE" + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of ServiceViewSourceType from a JSON string""" + return cls(json.loads(json_str)) diff --git a/koyeb/api_async/models/snapshot.py b/koyeb/api_async/models/snapshot.py index 341d134a..497554db 100644 --- a/koyeb/api_async/models/snapshot.py +++ b/koyeb/api_async/models/snapshot.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/snapshot_status.py b/koyeb/api_async/models/snapshot_status.py index 014feb59..d896d889 100644 --- a/koyeb/api_async/models/snapshot_status.py +++ b/koyeb/api_async/models/snapshot_status.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -32,6 +32,7 @@ class SnapshotStatus(str, Enum): SNAPSHOT_STATUS_MIGRATING = "SNAPSHOT_STATUS_MIGRATING" SNAPSHOT_STATUS_DELETING = "SNAPSHOT_STATUS_DELETING" SNAPSHOT_STATUS_DELETED = "SNAPSHOT_STATUS_DELETED" + SNAPSHOT_STATUS_ERROR = "SNAPSHOT_STATUS_ERROR" @classmethod def from_json(cls, json_str: str) -> Self: diff --git a/koyeb/api_async/models/snapshot_type.py b/koyeb/api_async/models/snapshot_type.py index ff34880b..54eafd24 100644 --- a/koyeb/api_async/models/snapshot_type.py +++ b/koyeb/api_async/models/snapshot_type.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/stream_result_of_exec_command_reply.py b/koyeb/api_async/models/stream_result_of_exec_command_reply.py index 161bb889..4fcdcbc0 100644 --- a/koyeb/api_async/models/stream_result_of_exec_command_reply.py +++ b/koyeb/api_async/models/stream_result_of_exec_command_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/stream_result_of_log_entry.py b/koyeb/api_async/models/stream_result_of_log_entry.py index 694d0a59..315cf9a6 100644 --- a/koyeb/api_async/models/stream_result_of_log_entry.py +++ b/koyeb/api_async/models/stream_result_of_log_entry.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/subscription.py b/koyeb/api_async/models/subscription.py index bb8041ff..24bfd0ba 100644 --- a/koyeb/api_async/models/subscription.py +++ b/koyeb/api_async/models/subscription.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/subscription_payment_failure.py b/koyeb/api_async/models/subscription_payment_failure.py index 065a8e6d..c326662a 100644 --- a/koyeb/api_async/models/subscription_payment_failure.py +++ b/koyeb/api_async/models/subscription_payment_failure.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/subscription_payment_failure_stripe_sdk.py b/koyeb/api_async/models/subscription_payment_failure_stripe_sdk.py index 3e97164c..c223a54a 100644 --- a/koyeb/api_async/models/subscription_payment_failure_stripe_sdk.py +++ b/koyeb/api_async/models/subscription_payment_failure_stripe_sdk.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/subscription_status.py b/koyeb/api_async/models/subscription_status.py index 9ca68e76..2a22f4ab 100644 --- a/koyeb/api_async/models/subscription_status.py +++ b/koyeb/api_async/models/subscription_status.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/tcp_health_check.py b/koyeb/api_async/models/tcp_health_check.py index a2938aed..4f87e20b 100644 --- a/koyeb/api_async/models/tcp_health_check.py +++ b/koyeb/api_async/models/tcp_health_check.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/token.py b/koyeb/api_async/models/token.py index bc4f8c88..f4c64d83 100644 --- a/koyeb/api_async/models/token.py +++ b/koyeb/api_async/models/token.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/trigger_deployment_metadata.py b/koyeb/api_async/models/trigger_deployment_metadata.py index 8a3707b6..24ede094 100644 --- a/koyeb/api_async/models/trigger_deployment_metadata.py +++ b/koyeb/api_async/models/trigger_deployment_metadata.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/trigger_deployment_metadata_actor_type.py b/koyeb/api_async/models/trigger_deployment_metadata_actor_type.py index 13d05047..e975670d 100644 --- a/koyeb/api_async/models/trigger_deployment_metadata_actor_type.py +++ b/koyeb/api_async/models/trigger_deployment_metadata_actor_type.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/trigger_deployment_metadata_trigger_type.py b/koyeb/api_async/models/trigger_deployment_metadata_trigger_type.py index 71bfb900..8ca06dd2 100644 --- a/koyeb/api_async/models/trigger_deployment_metadata_trigger_type.py +++ b/koyeb/api_async/models/trigger_deployment_metadata_trigger_type.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/trigger_git_deployment_metadata.py b/koyeb/api_async/models/trigger_git_deployment_metadata.py index ed920527..b856d207 100644 --- a/koyeb/api_async/models/trigger_git_deployment_metadata.py +++ b/koyeb/api_async/models/trigger_git_deployment_metadata.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/trigger_git_deployment_metadata_provider.py b/koyeb/api_async/models/trigger_git_deployment_metadata_provider.py index 41c0f8de..ca50bb5c 100644 --- a/koyeb/api_async/models/trigger_git_deployment_metadata_provider.py +++ b/koyeb/api_async/models/trigger_git_deployment_metadata_provider.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/update_app.py b/koyeb/api_async/models/update_app.py index b24c995a..1484f395 100644 --- a/koyeb/api_async/models/update_app.py +++ b/koyeb/api_async/models/update_app.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/update_app_reply.py b/koyeb/api_async/models/update_app_reply.py index 7bd3acb9..8c8ea552 100644 --- a/koyeb/api_async/models/update_app_reply.py +++ b/koyeb/api_async/models/update_app_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/update_budget_reply.py b/koyeb/api_async/models/update_budget_reply.py index f1baf2f1..55989648 100644 --- a/koyeb/api_async/models/update_budget_reply.py +++ b/koyeb/api_async/models/update_budget_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/update_budget_request.py b/koyeb/api_async/models/update_budget_request.py index 03739342..5c880fcc 100644 --- a/koyeb/api_async/models/update_budget_request.py +++ b/koyeb/api_async/models/update_budget_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/update_credential_reply.py b/koyeb/api_async/models/update_credential_reply.py index d680b946..eb158647 100644 --- a/koyeb/api_async/models/update_credential_reply.py +++ b/koyeb/api_async/models/update_credential_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/update_domain.py b/koyeb/api_async/models/update_domain.py index ab77593a..daefc9e8 100644 --- a/koyeb/api_async/models/update_domain.py +++ b/koyeb/api_async/models/update_domain.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/update_domain_reply.py b/koyeb/api_async/models/update_domain_reply.py index 6f19a86a..d7abbfb7 100644 --- a/koyeb/api_async/models/update_domain_reply.py +++ b/koyeb/api_async/models/update_domain_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/update_organization_default_project_reply.py b/koyeb/api_async/models/update_organization_default_project_reply.py index 9899b550..90a087a7 100644 --- a/koyeb/api_async/models/update_organization_default_project_reply.py +++ b/koyeb/api_async/models/update_organization_default_project_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/update_organization_default_project_request.py b/koyeb/api_async/models/update_organization_default_project_request.py index 6a94af83..24a0b156 100644 --- a/koyeb/api_async/models/update_organization_default_project_request.py +++ b/koyeb/api_async/models/update_organization_default_project_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/update_organization_name_reply.py b/koyeb/api_async/models/update_organization_name_reply.py index cb8f5453..eba381eb 100644 --- a/koyeb/api_async/models/update_organization_name_reply.py +++ b/koyeb/api_async/models/update_organization_name_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/update_organization_name_request.py b/koyeb/api_async/models/update_organization_name_request.py index 93f1f05e..5531f13b 100644 --- a/koyeb/api_async/models/update_organization_name_request.py +++ b/koyeb/api_async/models/update_organization_name_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/update_organization_plan_reply.py b/koyeb/api_async/models/update_organization_plan_reply.py index ad586cd9..1b520ecf 100644 --- a/koyeb/api_async/models/update_organization_plan_reply.py +++ b/koyeb/api_async/models/update_organization_plan_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/update_organization_plan_request.py b/koyeb/api_async/models/update_organization_plan_request.py index a9f636a7..b6a7ae14 100644 --- a/koyeb/api_async/models/update_organization_plan_request.py +++ b/koyeb/api_async/models/update_organization_plan_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/update_organization_reply.py b/koyeb/api_async/models/update_organization_reply.py index 676cfc5b..8b849e00 100644 --- a/koyeb/api_async/models/update_organization_reply.py +++ b/koyeb/api_async/models/update_organization_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/update_password_request.py b/koyeb/api_async/models/update_password_request.py index 14dd558e..7b98846d 100644 --- a/koyeb/api_async/models/update_password_request.py +++ b/koyeb/api_async/models/update_password_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/update_persistent_volume_reply.py b/koyeb/api_async/models/update_persistent_volume_reply.py index f5d9b437..ece22ee9 100644 --- a/koyeb/api_async/models/update_persistent_volume_reply.py +++ b/koyeb/api_async/models/update_persistent_volume_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/update_persistent_volume_request.py b/koyeb/api_async/models/update_persistent_volume_request.py index 26974afa..7e24305b 100644 --- a/koyeb/api_async/models/update_persistent_volume_request.py +++ b/koyeb/api_async/models/update_persistent_volume_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/update_project_reply.py b/koyeb/api_async/models/update_project_reply.py index 1de6f19e..5c6d60ce 100644 --- a/koyeb/api_async/models/update_project_reply.py +++ b/koyeb/api_async/models/update_project_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/update_secret_reply.py b/koyeb/api_async/models/update_secret_reply.py index 22989e7b..1e3a127d 100644 --- a/koyeb/api_async/models/update_secret_reply.py +++ b/koyeb/api_async/models/update_secret_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/update_service.py b/koyeb/api_async/models/update_service.py index f0c7de53..4fb815a9 100644 --- a/koyeb/api_async/models/update_service.py +++ b/koyeb/api_async/models/update_service.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/update_service_pool.py b/koyeb/api_async/models/update_service_pool.py index 49a5d33c..07aa04d6 100644 --- a/koyeb/api_async/models/update_service_pool.py +++ b/koyeb/api_async/models/update_service_pool.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/update_service_pool_reply.py b/koyeb/api_async/models/update_service_pool_reply.py index 1795dcda..661536b7 100644 --- a/koyeb/api_async/models/update_service_pool_reply.py +++ b/koyeb/api_async/models/update_service_pool_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/update_service_reply.py b/koyeb/api_async/models/update_service_reply.py index d9cbce3f..b2750552 100644 --- a/koyeb/api_async/models/update_service_reply.py +++ b/koyeb/api_async/models/update_service_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/update_service_scaling_request.py b/koyeb/api_async/models/update_service_scaling_request.py index 15f4b3e2..40db8481 100644 --- a/koyeb/api_async/models/update_service_scaling_request.py +++ b/koyeb/api_async/models/update_service_scaling_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/update_snapshot_reply.py b/koyeb/api_async/models/update_snapshot_reply.py index 64b59cae..dbd2f502 100644 --- a/koyeb/api_async/models/update_snapshot_reply.py +++ b/koyeb/api_async/models/update_snapshot_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/update_snapshot_request.py b/koyeb/api_async/models/update_snapshot_request.py index f466cbee..0fa3d6b6 100644 --- a/koyeb/api_async/models/update_snapshot_request.py +++ b/koyeb/api_async/models/update_snapshot_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/update_user_request_user_update_body.py b/koyeb/api_async/models/update_user_request_user_update_body.py index 0769c582..71462e9c 100644 --- a/koyeb/api_async/models/update_user_request_user_update_body.py +++ b/koyeb/api_async/models/update_user_request_user_update_body.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/update_user_settings_reply.py b/koyeb/api_async/models/update_user_settings_reply.py index 775850a5..e668da66 100644 --- a/koyeb/api_async/models/update_user_settings_reply.py +++ b/koyeb/api_async/models/update_user_settings_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/update_user_settings_request.py b/koyeb/api_async/models/update_user_settings_request.py index 0dd06786..e0b2c961 100644 --- a/koyeb/api_async/models/update_user_settings_request.py +++ b/koyeb/api_async/models/update_user_settings_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/upsert_signup_qualification_reply.py b/koyeb/api_async/models/upsert_signup_qualification_reply.py index 052015b9..1436e4ed 100644 --- a/koyeb/api_async/models/upsert_signup_qualification_reply.py +++ b/koyeb/api_async/models/upsert_signup_qualification_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/upsert_signup_qualification_request.py b/koyeb/api_async/models/upsert_signup_qualification_request.py index 3391bbb9..aed84ec8 100644 --- a/koyeb/api_async/models/upsert_signup_qualification_request.py +++ b/koyeb/api_async/models/upsert_signup_qualification_request.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/usage.py b/koyeb/api_async/models/usage.py index 16cc272d..f97a8534 100644 --- a/koyeb/api_async/models/usage.py +++ b/koyeb/api_async/models/usage.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/usage_details.py b/koyeb/api_async/models/usage_details.py index 4476e91f..7bf25c8c 100644 --- a/koyeb/api_async/models/usage_details.py +++ b/koyeb/api_async/models/usage_details.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/user.py b/koyeb/api_async/models/user.py index ac9c9094..3c986da4 100644 --- a/koyeb/api_async/models/user.py +++ b/koyeb/api_async/models/user.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/user_flags.py b/koyeb/api_async/models/user_flags.py index d17ba64c..7c300c58 100644 --- a/koyeb/api_async/models/user_flags.py +++ b/koyeb/api_async/models/user_flags.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/user_reply.py b/koyeb/api_async/models/user_reply.py index 233a17f7..86b49243 100644 --- a/koyeb/api_async/models/user_reply.py +++ b/koyeb/api_async/models/user_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/user_role_role.py b/koyeb/api_async/models/user_role_role.py index 900874be..e3c79944 100644 --- a/koyeb/api_async/models/user_role_role.py +++ b/koyeb/api_async/models/user_role_role.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/user_settings.py b/koyeb/api_async/models/user_settings.py index 3e77725c..c8d0f9d3 100644 --- a/koyeb/api_async/models/user_settings.py +++ b/koyeb/api_async/models/user_settings.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/verify_docker_image_reply.py b/koyeb/api_async/models/verify_docker_image_reply.py index d551ea17..477bc710 100644 --- a/koyeb/api_async/models/verify_docker_image_reply.py +++ b/koyeb/api_async/models/verify_docker_image_reply.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/models/verify_docker_image_reply_err_code.py b/koyeb/api_async/models/verify_docker_image_reply_err_code.py index b3212b42..af55ddf2 100644 --- a/koyeb/api_async/models/verify_docker_image_reply_err_code.py +++ b/koyeb/api_async/models/verify_docker_image_reply_err_code.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/rest.py b/koyeb/api_async/rest.py index 6d82d79b..0cbb3cd8 100644 --- a/koyeb/api_async/rest.py +++ b/koyeb/api_async/rest.py @@ -3,7 +3,7 @@ """ Koyeb Rest API - The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The version of the OpenAPI document: 1.0.0 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/koyeb/api_async/test/test_archive_status.py b/koyeb/api_async/test/test_archive_status.py new file mode 100644 index 00000000..121e8407 --- /dev/null +++ b/koyeb/api_async/test/test_archive_status.py @@ -0,0 +1,35 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from koyeb.api_async.models.archive_status import ArchiveStatus + + +class TestArchiveStatus(unittest.TestCase): + """ArchiveStatus unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testArchiveStatus(self): + """Test ArchiveStatus""" + # inst = ArchiveStatus() + + +if __name__ == "__main__": + unittest.main() diff --git a/koyeb/api_async/test/test_get_archive_reply.py b/koyeb/api_async/test/test_get_archive_reply.py new file mode 100644 index 00000000..827d9f3f --- /dev/null +++ b/koyeb/api_async/test/test_get_archive_reply.py @@ -0,0 +1,62 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from koyeb.api_async.models.get_archive_reply import GetArchiveReply + + +class TestGetArchiveReply(unittest.TestCase): + """GetArchiveReply unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> GetArchiveReply: + """Test GetArchiveReply + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included""" + # uncomment below to create an instance of `GetArchiveReply` + """ + model = GetArchiveReply() + if include_optional: + return GetArchiveReply( + archive = koyeb.api_async.models.archive.Archive( + id = '', + organization_id = '', + upload_url = '', + size = '', + created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + deleted_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + download_url = '', + download_url_deadline = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + status = 'ARCHIVE_STATUS_INVALID', ) + ) + else: + return GetArchiveReply( + ) + """ + + def testGetArchiveReply(self): + """Test GetArchiveReply""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == "__main__": + unittest.main() diff --git a/koyeb/api_async/test/test_kmeta_get_organization_workspace_quotas_reply.py b/koyeb/api_async/test/test_kmeta_get_organization_workspace_quotas_reply.py new file mode 100644 index 00000000..7dcb1e66 --- /dev/null +++ b/koyeb/api_async/test/test_kmeta_get_organization_workspace_quotas_reply.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from koyeb.api_async.models.kmeta_get_organization_workspace_quotas_reply import ( + KmetaGetOrganizationWorkspaceQuotasReply, +) + + +class TestKmetaGetOrganizationWorkspaceQuotasReply(unittest.TestCase): + """KmetaGetOrganizationWorkspaceQuotasReply unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance( + self, include_optional + ) -> KmetaGetOrganizationWorkspaceQuotasReply: + """Test KmetaGetOrganizationWorkspaceQuotasReply + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included""" + # uncomment below to create an instance of `KmetaGetOrganizationWorkspaceQuotasReply` + """ + model = KmetaGetOrganizationWorkspaceQuotasReply() + if include_optional: + return KmetaGetOrganizationWorkspaceQuotasReply( + quotas = koyeb.api_async.models.quotas.Quotas( + apps = '', + services = '', + domains = '', + service_provisioning_concurrency = '', + memory_mb = '', + instance_types = [ + '' + ], + regions = [ + '' + ], + max_organization_members = '', + max_instances_by_type = { + 'key' : '' + }, + persistent_volumes_by_region = { + 'key' : koyeb.api_async.models.persistent_volume_quotas.PersistentVolumeQuotas( + max_total_size = 56, + max_volume_size = 56, + max_per_instance_size = 56, ) + }, + custom_domains = '', + domains_load_balancer = koyeb.api_async.models.domain_load_balancer_quotas.DomainLoadBalancerQuotas( + max_koyeb = 56, ), + metrics_retention = 56, + logs_retention = 56, + access_reserved_subdomains = [ + '' + ], + proxy_ports = 56, + scale_to_zero = koyeb.api_async.models.scale_to_zero_quotas.ScaleToZeroQuotas( + is_deep_sleep_enabled = True, + deep_sleep_idle_delay_min = 56, + deep_sleep_idle_delay_max = 56, + is_light_sleep_enabled = True, + light_sleep_idle_delay_min = 56, + light_sleep_idle_delay_max = 56, ), + archives = '', + archive_max_size_mb = '', + lifecycle = koyeb.api_async.models.lifecycle_quotas.LifecycleQuotas( + delete_after_sleep_min = 56, + delete_after_sleep_max = 56, + delete_after_create_min = 56, + delete_after_create_max = 56, ), + max_projects = '', + instance_snapshots = koyeb.api_async.models.instance_snapshot_quotas.InstanceSnapshotQuotas( + filesystem = 56, + full = 56, ), + persistent_volumes_disabled = True, ) + ) + else: + return KmetaGetOrganizationWorkspaceQuotasReply( + ) + """ + + def testKmetaGetOrganizationWorkspaceQuotasReply(self): + """Test KmetaGetOrganizationWorkspaceQuotasReply""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == "__main__": + unittest.main() diff --git a/koyeb/api_async/test/test_list_archives_reply.py b/koyeb/api_async/test/test_list_archives_reply.py new file mode 100644 index 00000000..41793a26 --- /dev/null +++ b/koyeb/api_async/test/test_list_archives_reply.py @@ -0,0 +1,68 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from koyeb.api_async.models.list_archives_reply import ListArchivesReply + + +class TestListArchivesReply(unittest.TestCase): + """ListArchivesReply unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ListArchivesReply: + """Test ListArchivesReply + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included""" + # uncomment below to create an instance of `ListArchivesReply` + """ + model = ListArchivesReply() + if include_optional: + return ListArchivesReply( + archives = [ + koyeb.api_async.models.archive.Archive( + id = '', + organization_id = '', + upload_url = '', + size = '', + created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + deleted_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + download_url = '', + download_url_deadline = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + status = 'ARCHIVE_STATUS_INVALID', ) + ], + limit = 56, + offset = 56, + count = 56, + has_next = True + ) + else: + return ListArchivesReply( + ) + """ + + def testListArchivesReply(self): + """Test ListArchivesReply""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == "__main__": + unittest.main() diff --git a/koyeb/api_async/test/test_query_services_view_filters.py b/koyeb/api_async/test/test_query_services_view_filters.py new file mode 100644 index 00000000..f936fa8e --- /dev/null +++ b/koyeb/api_async/test/test_query_services_view_filters.py @@ -0,0 +1,71 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from koyeb.api_async.models.query_services_view_filters import QueryServicesViewFilters + + +class TestQueryServicesViewFilters(unittest.TestCase): + """QueryServicesViewFilters unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> QueryServicesViewFilters: + """Test QueryServicesViewFilters + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included""" + # uncomment below to create an instance of `QueryServicesViewFilters` + """ + model = QueryServicesViewFilters() + if include_optional: + return QueryServicesViewFilters( + types = [ + 'INVALID_TYPE' + ], + statuses = [ + 'STARTING' + ], + regions = [ + '' + ], + app_ids = [ + '' + ], + active_deployment_states = [ + 'NONE' + ], + latest_deployment_states = [ + 'NONE' + ], + needs_attention = True + ) + else: + return QueryServicesViewFilters( + ) + """ + + def testQueryServicesViewFilters(self): + """Test QueryServicesViewFilters""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == "__main__": + unittest.main() diff --git a/koyeb/api_async/test/test_query_services_view_reply.py b/koyeb/api_async/test/test_query_services_view_reply.py new file mode 100644 index 00000000..32d90d30 --- /dev/null +++ b/koyeb/api_async/test/test_query_services_view_reply.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from koyeb.api_async.models.query_services_view_reply import QueryServicesViewReply + + +class TestQueryServicesViewReply(unittest.TestCase): + """QueryServicesViewReply unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> QueryServicesViewReply: + """Test QueryServicesViewReply + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included""" + # uncomment below to create an instance of `QueryServicesViewReply` + """ + model = QueryServicesViewReply() + if include_optional: + return QueryServicesViewReply( + services = [ + koyeb.api_async.models.service_view_row.ServiceViewRow( + id = '', + name = '', + type = 'INVALID_TYPE', + status = 'STARTING', + messages = [ + '' + ], + created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + app_id = '', + app = koyeb.api_async.models.service_view_app.ServiceViewApp( + id = '', + name = '', ), + active_deployment = koyeb.api_async.models.service_view_active_deployment.ServiceViewActiveDeployment( + state = 'NONE', + id = '', + missing = True, + status = 'PENDING', + created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ), + latest_deployment = koyeb.api_async.models.service_view_latest_deployment.ServiceViewLatestDeployment( + state = 'NONE', + id = '', + missing = True, + status = 'PENDING', + created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ), + needs_attention = True, + regions = [ + '' + ], + instance_type = '', + source = koyeb.api_async.models.service_view_source.ServiceViewSource( + type = 'UNKNOWN', + reference = '', ), ) + ], + groups = [ + koyeb.api_async.models.service_view_group.ServiceViewGroup( + by = 'NO_GROUP', + key = '', + label = '', + count = 56, ) + ], + facets = [ + koyeb.api_async.models.service_view_facet.ServiceViewFacet( + kind = 'TYPE', + values = [ + koyeb.api_async.models.service_view_facet_value.ServiceViewFacetValue( + value = '', + label = '', + count = 56, ) + ], ) + ], + limit = 56, + offset = 56, + count = 56, + has_next = True + ) + else: + return QueryServicesViewReply( + ) + """ + + def testQueryServicesViewReply(self): + """Test QueryServicesViewReply""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == "__main__": + unittest.main() diff --git a/koyeb/api_async/test/test_query_services_view_sort.py b/koyeb/api_async/test/test_query_services_view_sort.py new file mode 100644 index 00000000..388d8a59 --- /dev/null +++ b/koyeb/api_async/test/test_query_services_view_sort.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from koyeb.api_async.models.query_services_view_sort import QueryServicesViewSort + + +class TestQueryServicesViewSort(unittest.TestCase): + """QueryServicesViewSort unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> QueryServicesViewSort: + """Test QueryServicesViewSort + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included""" + # uncomment below to create an instance of `QueryServicesViewSort` + """ + model = QueryServicesViewSort() + if include_optional: + return QueryServicesViewSort( + var_field = 'CREATED_AT', + direction = 'ASC' + ) + else: + return QueryServicesViewSort( + ) + """ + + def testQueryServicesViewSort(self): + """Test QueryServicesViewSort""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == "__main__": + unittest.main() diff --git a/koyeb/api_async/test/test_query_services_view_sort_direction.py b/koyeb/api_async/test/test_query_services_view_sort_direction.py new file mode 100644 index 00000000..a311c2ba --- /dev/null +++ b/koyeb/api_async/test/test_query_services_view_sort_direction.py @@ -0,0 +1,37 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from koyeb.api_async.models.query_services_view_sort_direction import ( + QueryServicesViewSortDirection, +) + + +class TestQueryServicesViewSortDirection(unittest.TestCase): + """QueryServicesViewSortDirection unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testQueryServicesViewSortDirection(self): + """Test QueryServicesViewSortDirection""" + # inst = QueryServicesViewSortDirection() + + +if __name__ == "__main__": + unittest.main() diff --git a/koyeb/api_async/test/test_query_services_view_sort_field.py b/koyeb/api_async/test/test_query_services_view_sort_field.py new file mode 100644 index 00000000..8c0a960c --- /dev/null +++ b/koyeb/api_async/test/test_query_services_view_sort_field.py @@ -0,0 +1,37 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from koyeb.api_async.models.query_services_view_sort_field import ( + QueryServicesViewSortField, +) + + +class TestQueryServicesViewSortField(unittest.TestCase): + """QueryServicesViewSortField unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testQueryServicesViewSortField(self): + """Test QueryServicesViewSortField""" + # inst = QueryServicesViewSortField() + + +if __name__ == "__main__": + unittest.main() diff --git a/koyeb/api_async/test/test_service_view_active_deployment.py b/koyeb/api_async/test/test_service_view_active_deployment.py new file mode 100644 index 00000000..63f141f5 --- /dev/null +++ b/koyeb/api_async/test/test_service_view_active_deployment.py @@ -0,0 +1,60 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from koyeb.api_async.models.service_view_active_deployment import ( + ServiceViewActiveDeployment, +) + + +class TestServiceViewActiveDeployment(unittest.TestCase): + """ServiceViewActiveDeployment unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServiceViewActiveDeployment: + """Test ServiceViewActiveDeployment + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included""" + # uncomment below to create an instance of `ServiceViewActiveDeployment` + """ + model = ServiceViewActiveDeployment() + if include_optional: + return ServiceViewActiveDeployment( + state = 'NONE', + id = '', + missing = True, + status = 'PENDING', + created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f') + ) + else: + return ServiceViewActiveDeployment( + ) + """ + + def testServiceViewActiveDeployment(self): + """Test ServiceViewActiveDeployment""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == "__main__": + unittest.main() diff --git a/koyeb/api_async/test/test_service_view_active_deployment_state.py b/koyeb/api_async/test/test_service_view_active_deployment_state.py new file mode 100644 index 00000000..89d72697 --- /dev/null +++ b/koyeb/api_async/test/test_service_view_active_deployment_state.py @@ -0,0 +1,37 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from koyeb.api_async.models.service_view_active_deployment_state import ( + ServiceViewActiveDeploymentState, +) + + +class TestServiceViewActiveDeploymentState(unittest.TestCase): + """ServiceViewActiveDeploymentState unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testServiceViewActiveDeploymentState(self): + """Test ServiceViewActiveDeploymentState""" + # inst = ServiceViewActiveDeploymentState() + + +if __name__ == "__main__": + unittest.main() diff --git a/koyeb/api_async/test/test_service_view_app.py b/koyeb/api_async/test/test_service_view_app.py new file mode 100644 index 00000000..b68e2b97 --- /dev/null +++ b/koyeb/api_async/test/test_service_view_app.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from koyeb.api_async.models.service_view_app import ServiceViewApp + + +class TestServiceViewApp(unittest.TestCase): + """ServiceViewApp unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServiceViewApp: + """Test ServiceViewApp + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included""" + # uncomment below to create an instance of `ServiceViewApp` + """ + model = ServiceViewApp() + if include_optional: + return ServiceViewApp( + id = '', + name = '' + ) + else: + return ServiceViewApp( + ) + """ + + def testServiceViewApp(self): + """Test ServiceViewApp""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == "__main__": + unittest.main() diff --git a/koyeb/api_async/test/test_service_view_facet.py b/koyeb/api_async/test/test_service_view_facet.py new file mode 100644 index 00000000..c568afe8 --- /dev/null +++ b/koyeb/api_async/test/test_service_view_facet.py @@ -0,0 +1,59 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from koyeb.api_async.models.service_view_facet import ServiceViewFacet + + +class TestServiceViewFacet(unittest.TestCase): + """ServiceViewFacet unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServiceViewFacet: + """Test ServiceViewFacet + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included""" + # uncomment below to create an instance of `ServiceViewFacet` + """ + model = ServiceViewFacet() + if include_optional: + return ServiceViewFacet( + kind = 'TYPE', + values = [ + koyeb.api_async.models.service_view_facet_value.ServiceViewFacetValue( + value = '', + label = '', + count = 56, ) + ] + ) + else: + return ServiceViewFacet( + ) + """ + + def testServiceViewFacet(self): + """Test ServiceViewFacet""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == "__main__": + unittest.main() diff --git a/koyeb/api_async/test/test_service_view_facet_kind.py b/koyeb/api_async/test/test_service_view_facet_kind.py new file mode 100644 index 00000000..f3d9893d --- /dev/null +++ b/koyeb/api_async/test/test_service_view_facet_kind.py @@ -0,0 +1,35 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from koyeb.api_async.models.service_view_facet_kind import ServiceViewFacetKind + + +class TestServiceViewFacetKind(unittest.TestCase): + """ServiceViewFacetKind unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testServiceViewFacetKind(self): + """Test ServiceViewFacetKind""" + # inst = ServiceViewFacetKind() + + +if __name__ == "__main__": + unittest.main() diff --git a/koyeb/api_async/test/test_service_view_facet_value.py b/koyeb/api_async/test/test_service_view_facet_value.py new file mode 100644 index 00000000..02ee7e7e --- /dev/null +++ b/koyeb/api_async/test/test_service_view_facet_value.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from koyeb.api_async.models.service_view_facet_value import ServiceViewFacetValue + + +class TestServiceViewFacetValue(unittest.TestCase): + """ServiceViewFacetValue unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServiceViewFacetValue: + """Test ServiceViewFacetValue + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included""" + # uncomment below to create an instance of `ServiceViewFacetValue` + """ + model = ServiceViewFacetValue() + if include_optional: + return ServiceViewFacetValue( + value = '', + label = '', + count = 56 + ) + else: + return ServiceViewFacetValue( + ) + """ + + def testServiceViewFacetValue(self): + """Test ServiceViewFacetValue""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == "__main__": + unittest.main() diff --git a/koyeb/api_async/test/test_service_view_group.py b/koyeb/api_async/test/test_service_view_group.py new file mode 100644 index 00000000..b16a58b9 --- /dev/null +++ b/koyeb/api_async/test/test_service_view_group.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from koyeb.api_async.models.service_view_group import ServiceViewGroup + + +class TestServiceViewGroup(unittest.TestCase): + """ServiceViewGroup unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServiceViewGroup: + """Test ServiceViewGroup + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included""" + # uncomment below to create an instance of `ServiceViewGroup` + """ + model = ServiceViewGroup() + if include_optional: + return ServiceViewGroup( + by = 'NO_GROUP', + key = '', + label = '', + count = 56 + ) + else: + return ServiceViewGroup( + ) + """ + + def testServiceViewGroup(self): + """Test ServiceViewGroup""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == "__main__": + unittest.main() diff --git a/koyeb/api_async/test/test_service_view_group_by.py b/koyeb/api_async/test/test_service_view_group_by.py new file mode 100644 index 00000000..0a1c0aae --- /dev/null +++ b/koyeb/api_async/test/test_service_view_group_by.py @@ -0,0 +1,35 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from koyeb.api_async.models.service_view_group_by import ServiceViewGroupBy + + +class TestServiceViewGroupBy(unittest.TestCase): + """ServiceViewGroupBy unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testServiceViewGroupBy(self): + """Test ServiceViewGroupBy""" + # inst = ServiceViewGroupBy() + + +if __name__ == "__main__": + unittest.main() diff --git a/koyeb/api_async/test/test_service_view_latest_deployment.py b/koyeb/api_async/test/test_service_view_latest_deployment.py new file mode 100644 index 00000000..3eef8551 --- /dev/null +++ b/koyeb/api_async/test/test_service_view_latest_deployment.py @@ -0,0 +1,60 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from koyeb.api_async.models.service_view_latest_deployment import ( + ServiceViewLatestDeployment, +) + + +class TestServiceViewLatestDeployment(unittest.TestCase): + """ServiceViewLatestDeployment unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServiceViewLatestDeployment: + """Test ServiceViewLatestDeployment + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included""" + # uncomment below to create an instance of `ServiceViewLatestDeployment` + """ + model = ServiceViewLatestDeployment() + if include_optional: + return ServiceViewLatestDeployment( + state = 'NONE', + id = '', + missing = True, + status = 'PENDING', + created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f') + ) + else: + return ServiceViewLatestDeployment( + ) + """ + + def testServiceViewLatestDeployment(self): + """Test ServiceViewLatestDeployment""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == "__main__": + unittest.main() diff --git a/koyeb/api_async/test/test_service_view_latest_deployment_state.py b/koyeb/api_async/test/test_service_view_latest_deployment_state.py new file mode 100644 index 00000000..9db036db --- /dev/null +++ b/koyeb/api_async/test/test_service_view_latest_deployment_state.py @@ -0,0 +1,37 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from koyeb.api_async.models.service_view_latest_deployment_state import ( + ServiceViewLatestDeploymentState, +) + + +class TestServiceViewLatestDeploymentState(unittest.TestCase): + """ServiceViewLatestDeploymentState unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testServiceViewLatestDeploymentState(self): + """Test ServiceViewLatestDeploymentState""" + # inst = ServiceViewLatestDeploymentState() + + +if __name__ == "__main__": + unittest.main() diff --git a/koyeb/api_async/test/test_service_view_row.py b/koyeb/api_async/test/test_service_view_row.py new file mode 100644 index 00000000..1dad1824 --- /dev/null +++ b/koyeb/api_async/test/test_service_view_row.py @@ -0,0 +1,87 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from koyeb.api_async.models.service_view_row import ServiceViewRow + + +class TestServiceViewRow(unittest.TestCase): + """ServiceViewRow unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServiceViewRow: + """Test ServiceViewRow + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included""" + # uncomment below to create an instance of `ServiceViewRow` + """ + model = ServiceViewRow() + if include_optional: + return ServiceViewRow( + id = '', + name = '', + type = 'INVALID_TYPE', + status = 'STARTING', + messages = [ + '' + ], + created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + app_id = '', + app = koyeb.api_async.models.service_view_app.ServiceViewApp( + id = '', + name = '', ), + active_deployment = koyeb.api_async.models.service_view_active_deployment.ServiceViewActiveDeployment( + state = 'NONE', + id = '', + missing = True, + status = 'PENDING', + created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ), + latest_deployment = koyeb.api_async.models.service_view_latest_deployment.ServiceViewLatestDeployment( + state = 'NONE', + id = '', + missing = True, + status = 'PENDING', + created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ), + needs_attention = True, + regions = [ + '' + ], + instance_type = '', + source = koyeb.api_async.models.service_view_source.ServiceViewSource( + type = 'UNKNOWN', + reference = '', ) + ) + else: + return ServiceViewRow( + ) + """ + + def testServiceViewRow(self): + """Test ServiceViewRow""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == "__main__": + unittest.main() diff --git a/koyeb/api_async/test/test_service_view_source.py b/koyeb/api_async/test/test_service_view_source.py new file mode 100644 index 00000000..4b41d151 --- /dev/null +++ b/koyeb/api_async/test/test_service_view_source.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from koyeb.api_async.models.service_view_source import ServiceViewSource + + +class TestServiceViewSource(unittest.TestCase): + """ServiceViewSource unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ServiceViewSource: + """Test ServiceViewSource + include_optional is a boolean, when False only required + params are included, when True both required and + optional params are included""" + # uncomment below to create an instance of `ServiceViewSource` + """ + model = ServiceViewSource() + if include_optional: + return ServiceViewSource( + type = 'UNKNOWN', + reference = '' + ) + else: + return ServiceViewSource( + ) + """ + + def testServiceViewSource(self): + """Test ServiceViewSource""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == "__main__": + unittest.main() diff --git a/koyeb/api_async/test/test_service_view_source_type.py b/koyeb/api_async/test/test_service_view_source_type.py new file mode 100644 index 00000000..ad566e03 --- /dev/null +++ b/koyeb/api_async/test/test_service_view_source_type.py @@ -0,0 +1,35 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from koyeb.api_async.models.service_view_source_type import ServiceViewSourceType + + +class TestServiceViewSourceType(unittest.TestCase): + """ServiceViewSourceType unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testServiceViewSourceType(self): + """Test ServiceViewSourceType""" + # inst = ServiceViewSourceType() + + +if __name__ == "__main__": + unittest.main() diff --git a/koyeb/api_async/test/test_service_views_api.py b/koyeb/api_async/test/test_service_views_api.py new file mode 100644 index 00000000..9799bf4b --- /dev/null +++ b/koyeb/api_async/test/test_service_views_api.py @@ -0,0 +1,38 @@ +# coding: utf-8 + +""" + Koyeb Rest API + + Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. + + The version of the OpenAPI document: 1.0.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from koyeb.api_async.api.service_views_api import ServiceViewsApi + + +class TestServiceViewsApi(unittest.IsolatedAsyncioTestCase): + """ServiceViewsApi unit test stubs""" + + async def asyncSetUp(self) -> None: + self.api = ServiceViewsApi() + + async def asyncTearDown(self) -> None: + await self.api.api_client.close() + + async def test_query_services_view(self) -> None: + """Test case for query_services_view + + Query the Services view + """ + pass + + +if __name__ == "__main__": + unittest.main() diff --git a/koyeb/api_async_README.md b/koyeb/api_async_README.md index 6aeef938..d18a4e4a 100644 --- a/koyeb/api_async_README.md +++ b/koyeb/api_async_README.md @@ -1,16 +1,16 @@ # koyeb.api-async -The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. +Welcome to the Koyeb API documentation. The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests. The API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently. The API returns JSON-encoded responses and uses standard HTTP response codes, and verbs. All of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required. All production API requests are made to: - https://app.koyeb.com/ All data is sent and received as JSON. ## Constructing Requests Requests are made of three components: - Base URL: `https://app.koyeb.com` - API Version: `v1` - Resource path: `apps` To construct a proper request, you need to format the URL as follows: `https://app.koyeb.com/{version}/{resource}` Example: `https://app.koyeb.com/v1/apps` The following code is an example request to retrieve the list of Apps. ``` $ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps { \"apps\": [ { \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\", \"name\": \"demo\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-04-26T08:28:59.221274Z\", \"created_at\": \"2021-04-26T08:28:59.221274Z\", \"domains\": [ { \"name\": \"demo-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] }, { \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\", \"name\": \"www\", \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\", \"updated_at\": \"2021-05-04T08:56:40.557792Z\", \"created_at\": \"2021-05-04T08:56:40.557792Z\", \"domains\": [ { \"name\": \"www-koyeb.koyeb.app\", \"deployment_group\": \"prod\" } ] } ], \"limit\": 20, \"offset\": 0, \"count\": 2 } ``` # Authentication The Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel. Your API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth. To make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `: ``` Authorization: Bearer ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers. ## HTTP Status Code Summary - `200 OK` - Everything worked as expected. - `400 Bad Request` - Often missing a required parameter. - `401 Unauthorized` - No valid API key provided. - `402 Request Failed` - Parameters were valid, but the request failed. - `403 Forbidden` - Insufficient privileges to access the requested resource. - `404 Not Found` - The requested item doesn't exist. - `50x` Server errors - Something went wrong on the API domain's end. Input and output data must be valid JSON with the appropriate Content-Type header set. ## Attributes - code: - `invalid_argument`: Occur when your request has invalid parameters. - `unknown_resource`: Occur when the resource doesn't exist. - `authentication_error`: Arise when there is a problem with authentication. - `rate_limit_error`: Too many requests hit the API too quickly. - `authorization_required`: You don't have sufficient right to access the resource. - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon). - message: - A human-readable error giving more details about the error - status: - The HTTP code returned by the server. - fields (Optional): - An array of parameters with a human-readable message giving more details about the error. ## Errors responses example Response 400 (application/json) ``` { \"status\": 400, \"code\": \"invalid_argument\", \"message\": \"Invalid argument\", \"fields\": [ { \"field\": \"definition.docker.image\", \"description\": \"cannot be blank\" } ] } ``` Response 401 (application/json) ``` { \"status\": 401, \"code\": \"authentication_error\", \"message\": \"Request unauthenticated with bearer\" } ``` Response 403 (application/json) ``` { \"status\": 403, \"code\": \"authentication_required\", \"message\": \"You don't have the requested permission to access to resource.\" } ``` Response 404 (application/json) ``` { \"status\": 404, \"code\": \"unknown_resource\", \"message\": \"App not found\" } ``` # Pagination All top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset. **Paginated request** Requests against paginated endpoints accept two query string arguments: * *limit*, a positive integer lower or equal to 100 to select the number of items to display. * *offset*, an integer to indicate the position to start at. Paginated endpoints usually also accept filters to search and sort results. These filters are documented along with each endpoint documentation. The `koyeb.api_async` package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: - API version: 1.0.0 -- Package version: 1.6.1 -- Generator version: 7.27.0-SNAPSHOT +- Package version: 1.6.2 +- Generator version: 7.28.0-SNAPSHOT - Build package: org.openapitools.codegen.languages.PythonClientCodegen ## Requirements. -Python 3.10+ +Python 3.11+ ## Installation & Usage @@ -86,6 +86,9 @@ Class | Method | HTTP request | Description *AppsApi* | [**update_app**](koyeb/api_async/docs/AppsApi.md#update_app) | **PUT** /v1/apps/{id} | Update App *AppsApi* | [**update_app2**](koyeb/api_async/docs/AppsApi.md#update_app2) | **PATCH** /v1/apps/{id} | Update App *ArchivesApi* | [**create_archive**](koyeb/api_async/docs/ArchivesApi.md#create_archive) | **POST** /v1/archives | Create Archive +*ArchivesApi* | [**delete_archive**](koyeb/api_async/docs/ArchivesApi.md#delete_archive) | **DELETE** /v1/archives/{id} | Delete Archive +*ArchivesApi* | [**get_archive**](koyeb/api_async/docs/ArchivesApi.md#get_archive) | **GET** /v1/archives/{id} | Get Archive +*ArchivesApi* | [**list_archives**](koyeb/api_async/docs/ArchivesApi.md#list_archives) | **GET** /v1/archives | List Archives *CatalogDatacentersApi* | [**list_datacenters**](koyeb/api_async/docs/CatalogDatacentersApi.md#list_datacenters) | **GET** /v1/catalog/datacenters | List datacenters *CatalogInstanceUsageApi* | [**list_usage**](koyeb/api_async/docs/CatalogInstanceUsageApi.md#list_usage) | **GET** /v1/catalog/usage | *CatalogInstancesApi* | [**get_catalog_instance**](koyeb/api_async/docs/CatalogInstancesApi.md#get_catalog_instance) | **GET** /v1/catalog/instances/{id} | Get Instance @@ -182,6 +185,7 @@ Class | Method | HTTP request | Description *ProvisioningApi* | [**declare_stage_progress**](koyeb/api_async/docs/ProvisioningApi.md#declare_stage_progress) | **PATCH** /v1/provisioning/{deployment_id}/status/{stage}/{attempt} | Declare stage progress *ProvisioningApi* | [**declare_step_progress**](koyeb/api_async/docs/ProvisioningApi.md#declare_step_progress) | **PATCH** /v1/provisioning/{deployment_id}/status/{stage}/{attempt}/{step} | Declare step progress *QuotasApi* | [**get_organization_quotas_usage**](koyeb/api_async/docs/QuotasApi.md#get_organization_quotas_usage) | **GET** /v1/quotas/organizations/{organization_id}/usage | Return the organization's current quota usage alongside the plan's limits. Response is cached in Redis for 60s. Accept text/plain (or ?format=prometheus) to receive the response rendered as Prometheus text exposition format (\"koyeb_quota_<x>\" for usage, \"koyeb_quota_<x>_limit\" for the plan limit) suitable for scraping into an external Prometheus. +*QuotasApi* | [**get_organization_workspace_quotas**](koyeb/api_async/docs/QuotasApi.md#get_organization_workspace_quotas) | **GET** /v1/quotas/organizations/{organization_id}/{workspace_id}/quotas | *QuotasApi* | [**review_organization_capacity**](koyeb/api_async/docs/QuotasApi.md#review_organization_capacity) | **POST** /v1/quotas/capacity | DEPRECATED: Review Organization Capacity *RegionalDeploymentsApi* | [**get_regional_deployment**](koyeb/api_async/docs/RegionalDeploymentsApi.md#get_regional_deployment) | **GET** /v1/regional_deployments/{id} | Get Regional Deployment *RegionalDeploymentsApi* | [**list_regional_deployment_events**](koyeb/api_async/docs/RegionalDeploymentsApi.md#list_regional_deployment_events) | **GET** /v1/regional_deployment_events | List Regional Deployment events @@ -202,6 +206,7 @@ Class | Method | HTTP request | Description *ServicePoolsApi* | [**get_service_pool**](koyeb/api_async/docs/ServicePoolsApi.md#get_service_pool) | **GET** /v1/service_pools/{id} | Get a ServicePool *ServicePoolsApi* | [**list_service_pools**](koyeb/api_async/docs/ServicePoolsApi.md#list_service_pools) | **GET** /v1/service_pools | List ServicePools *ServicePoolsApi* | [**update_service_pool**](koyeb/api_async/docs/ServicePoolsApi.md#update_service_pool) | **PUT** /v1/service_pools/{id} | +*ServiceViewsApi* | [**query_services_view**](koyeb/api_async/docs/ServiceViewsApi.md#query_services_view) | **GET** /v1/views/services | Query the Services view *ServicesApi* | [**autocomplete**](koyeb/api_async/docs/ServicesApi.md#autocomplete) | **POST** /v1/services-autocomplete | Autocomplete definition *ServicesApi* | [**create_service**](koyeb/api_async/docs/ServicesApi.md#create_service) | **POST** /v1/services | Create Service *ServicesApi* | [**delete_service**](koyeb/api_async/docs/ServicesApi.md#delete_service) | **DELETE** /v1/services/{id} | Delete Service @@ -280,6 +285,7 @@ Class | Method | HTTP request | Description - [Archive](koyeb/api_async/docs/Archive.md) - [ArchiveDeploymentMetadata](koyeb/api_async/docs/ArchiveDeploymentMetadata.md) - [ArchiveSource](koyeb/api_async/docs/ArchiveSource.md) + - [ArchiveStatus](koyeb/api_async/docs/ArchiveStatus.md) - [AutoRelease](koyeb/api_async/docs/AutoRelease.md) - [AutoReleaseGroup](koyeb/api_async/docs/AutoReleaseGroup.md) - [AutocompleteReply](koyeb/api_async/docs/AutocompleteReply.md) @@ -414,6 +420,7 @@ Class | Method | HTTP request | Description - [GCPContainerRegistryConfiguration](koyeb/api_async/docs/GCPContainerRegistryConfiguration.md) - [GRPCHealthCheck](koyeb/api_async/docs/GRPCHealthCheck.md) - [GetAppReply](koyeb/api_async/docs/GetAppReply.md) + - [GetArchiveReply](koyeb/api_async/docs/GetArchiveReply.md) - [GetBudgetReply](koyeb/api_async/docs/GetBudgetReply.md) - [GetCatalogInstanceReply](koyeb/api_async/docs/GetCatalogInstanceReply.md) - [GetCredentialReply](koyeb/api_async/docs/GetCredentialReply.md) @@ -486,6 +493,7 @@ Class | Method | HTTP request | Description - [KgitproxyListRepositoriesReply](koyeb/api_async/docs/KgitproxyListRepositoriesReply.md) - [KgitproxyRepository](koyeb/api_async/docs/KgitproxyRepository.md) - [KgitproxyRepositoryProvider](koyeb/api_async/docs/KgitproxyRepositoryProvider.md) + - [KmetaGetOrganizationWorkspaceQuotasReply](koyeb/api_async/docs/KmetaGetOrganizationWorkspaceQuotasReply.md) - [KsearchApp](koyeb/api_async/docs/KsearchApp.md) - [KsearchGlobalDeployment](koyeb/api_async/docs/KsearchGlobalDeployment.md) - [KsearchInstance](koyeb/api_async/docs/KsearchInstance.md) @@ -499,6 +507,7 @@ Class | Method | HTTP request | Description - [LifecycleQuotas](koyeb/api_async/docs/LifecycleQuotas.md) - [ListAppEventsReply](koyeb/api_async/docs/ListAppEventsReply.md) - [ListAppsReply](koyeb/api_async/docs/ListAppsReply.md) + - [ListArchivesReply](koyeb/api_async/docs/ListArchivesReply.md) - [ListCatalogInstancesReply](koyeb/api_async/docs/ListCatalogInstancesReply.md) - [ListCredentialsReply](koyeb/api_async/docs/ListCredentialsReply.md) - [ListDatacentersReply](koyeb/api_async/docs/ListDatacentersReply.md) @@ -588,6 +597,11 @@ Class | Method | HTTP request | Description - [PublicUser](koyeb/api_async/docs/PublicUser.md) - [QueryLogsReply](koyeb/api_async/docs/QueryLogsReply.md) - [QueryLogsReplyPagination](koyeb/api_async/docs/QueryLogsReplyPagination.md) + - [QueryServicesViewFilters](koyeb/api_async/docs/QueryServicesViewFilters.md) + - [QueryServicesViewReply](koyeb/api_async/docs/QueryServicesViewReply.md) + - [QueryServicesViewSort](koyeb/api_async/docs/QueryServicesViewSort.md) + - [QueryServicesViewSortDirection](koyeb/api_async/docs/QueryServicesViewSortDirection.md) + - [QueryServicesViewSortField](koyeb/api_async/docs/QueryServicesViewSortField.md) - [QuotaUsage](koyeb/api_async/docs/QuotaUsage.md) - [Quotas](koyeb/api_async/docs/Quotas.md) - [ReactivateOrganizationReply](koyeb/api_async/docs/ReactivateOrganizationReply.md) @@ -634,6 +648,19 @@ Class | Method | HTTP request | Description - [ServiceSummary](koyeb/api_async/docs/ServiceSummary.md) - [ServiceType](koyeb/api_async/docs/ServiceType.md) - [ServiceUsage](koyeb/api_async/docs/ServiceUsage.md) + - [ServiceViewActiveDeployment](koyeb/api_async/docs/ServiceViewActiveDeployment.md) + - [ServiceViewActiveDeploymentState](koyeb/api_async/docs/ServiceViewActiveDeploymentState.md) + - [ServiceViewApp](koyeb/api_async/docs/ServiceViewApp.md) + - [ServiceViewFacet](koyeb/api_async/docs/ServiceViewFacet.md) + - [ServiceViewFacetKind](koyeb/api_async/docs/ServiceViewFacetKind.md) + - [ServiceViewFacetValue](koyeb/api_async/docs/ServiceViewFacetValue.md) + - [ServiceViewGroup](koyeb/api_async/docs/ServiceViewGroup.md) + - [ServiceViewGroupBy](koyeb/api_async/docs/ServiceViewGroupBy.md) + - [ServiceViewLatestDeployment](koyeb/api_async/docs/ServiceViewLatestDeployment.md) + - [ServiceViewLatestDeploymentState](koyeb/api_async/docs/ServiceViewLatestDeploymentState.md) + - [ServiceViewRow](koyeb/api_async/docs/ServiceViewRow.md) + - [ServiceViewSource](koyeb/api_async/docs/ServiceViewSource.md) + - [ServiceViewSourceType](koyeb/api_async/docs/ServiceViewSourceType.md) - [Snapshot](koyeb/api_async/docs/Snapshot.md) - [SnapshotStatus](koyeb/api_async/docs/SnapshotStatus.md) - [SnapshotType](koyeb/api_async/docs/SnapshotType.md) diff --git a/koyeb/sandbox/__init__.py b/koyeb/sandbox/__init__.py index 733c3a95..b1d3ff16 100644 --- a/koyeb/sandbox/__init__.py +++ b/koyeb/sandbox/__init__.py @@ -4,7 +4,7 @@ Koyeb Sandbox - Interactive execution environment for running arbitrary code on Koyeb """ -__version__ = "1.6.1" +__version__ = "1.6.2" from koyeb.api.models.config_file import ConfigFile from koyeb.api.models.instance_status import InstanceStatus as SandboxStatus diff --git a/koyeb/sandbox/test_snapshot_list.py b/koyeb/sandbox/test_snapshot_list.py index d7cdc261..30021654 100644 --- a/koyeb/sandbox/test_snapshot_list.py +++ b/koyeb/sandbox/test_snapshot_list.py @@ -96,7 +96,16 @@ def test_shared_filter_set_matches_the_js_parity_set(self): params = set(inspect.signature(Snapshot.list).parameters) self.assertEqual( params, - {"service_id", "name", "snapshot_type", "status", "limit", "offset", "api_token", "host"}, + { + "service_id", + "name", + "snapshot_type", + "status", + "limit", + "offset", + "api_token", + "host", + }, ) diff --git a/pyproject.toml b/pyproject.toml index cda56866..e1a889be 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "koyeb-sdk" -version = "1.6.1" +version = "1.6.2" description = "Koyeb python sdk" authors = [{ name = "Koyeb team", email = "support@koyeb.com" }] license = "Apache-2.0" diff --git a/spec/openapi.json b/spec/openapi.json index d817b21d..47e76b26 100644 --- a/spec/openapi.json +++ b/spec/openapi.json @@ -2,33 +2,14 @@ "swagger": "2.0", "info": { "title": "Koyeb Rest API", - "description": "The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests.\n", + "description": "Welcome to the Koyeb API documentation.\n\nThe Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests.\nThe API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently.\n\nThe API returns JSON-encoded responses and uses standard HTTP response codes, and verbs.\n\nAll of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required.\n\nAll production API requests are made to:\n\n- https://app.koyeb.com/\n\nAll data is sent and received as JSON.\n\n## Constructing Requests\n\nRequests are made of three components:\n\n- Base URL: `https://app.koyeb.com`\n- API Version: `v1`\n- Resource path: `apps`\n\nTo construct a proper request, you need to format the URL as follows:\n\n`https://app.koyeb.com/{version}/{resource}`\n\nExample: `https://app.koyeb.com/v1/apps`\n\nThe following code is an example request to retrieve the list of Apps.\n\n```\n$ curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps\n{\n \"apps\": [\n {\n \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\",\n \"name\": \"demo\",\n \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\",\n \"updated_at\": \"2021-04-26T08:28:59.221274Z\",\n \"created_at\": \"2021-04-26T08:28:59.221274Z\",\n \"domains\": [\n {\n \"name\": \"demo-koyeb.koyeb.app\",\n \"deployment_group\": \"prod\"\n }\n ]\n },\n {\n \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\",\n \"name\": \"www\",\n \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\",\n \"updated_at\": \"2021-05-04T08:56:40.557792Z\",\n \"created_at\": \"2021-05-04T08:56:40.557792Z\",\n \"domains\": [\n {\n \"name\": \"www-koyeb.koyeb.app\",\n \"deployment_group\": \"prod\"\n }\n ]\n }\n ],\n \"limit\": 20,\n \"offset\": 0,\n \"count\": 2\n}\n```\n\n# Authentication\n\nThe Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel.\n\nYour API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth.\n\nTo make an authenticated request, include a bearer-type Authorization header containing your API key, prefixed with `Bearer `:\n\n```\nAuthorization: Bearer \n```\n\nAll API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.\n\n# Errors\n\nWe use conventional HTTP response codes to indicate the success or failure of an API request.\n\nIn general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers.\n\n## HTTP Status Code Summary\n\n- `200 OK` - Everything worked as expected.\n- `400 Bad Request` - Often missing a required parameter.\n- `401 Unauthorized` - No valid API key provided.\n- `402 Request Failed` - Parameters were valid, but the request failed.\n- `403 Forbidden` - Insufficient privileges to access the requested resource.\n- `404 Not Found` - The requested item doesn't exist.\n- `50x` Server errors - Something went wrong on the API domain's end.\n\nInput and output data must be valid JSON with the appropriate Content-Type header set.\n\n## Attributes\n\n- code:\n\n - `invalid_argument`: Occur when your request has invalid parameters.\n - `unknown_resource`: Occur when the resource doesn't exist.\n - `authentication_error`: Arise when there is a problem with authentication.\n - `rate_limit_error`: Too many requests hit the API too quickly.\n - `authorization_required`: You don't have sufficient right to access the resource.\n - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon).\n\n- message:\n\n - A human-readable error giving more details about the error\n\n- status:\n\n - The HTTP code returned by the server.\n\n- fields (Optional):\n\n - An array of parameters with a human-readable message giving more details about the error.\n\n## Errors responses example\n\nResponse 400 (application/json)\n\n```\n{\n \"status\": 400,\n \"code\": \"invalid_argument\",\n \"message\": \"Invalid argument\",\n \"fields\": [\n {\n \"field\": \"definition.docker.image\",\n \"description\": \"cannot be blank\"\n }\n ]\n}\n```\n\nResponse 401 (application/json)\n\n```\n{\n \"status\": 401,\n \"code\": \"authentication_error\",\n \"message\": \"Request unauthenticated with bearer\"\n}\n```\n\nResponse 403 (application/json)\n\n```\n{\n \"status\": 403,\n \"code\": \"authentication_required\",\n \"message\": \"You don't have the requested permission to access to resource.\"\n}\n```\n\n\nResponse 404 (application/json)\n\n```\n{\n \"status\": 404,\n \"code\": \"unknown_resource\",\n \"message\": \"App not found\"\n}\n```\n\n# Pagination\n\nAll top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset.\n\n**Paginated request**\n\nRequests against paginated endpoints accept two query string arguments:\n\n* *limit*, a positive integer lower or equal to 100 to select the number of items to display.\n* *offset*, an integer to indicate the position to start at.\n\nPaginated endpoints usually also accept filters to search and sort results.\nThese filters are documented along with each endpoint documentation.\n", "version": "1.0.0" }, "host": "app.koyeb.com", "schemes": [ "https" ], - "security": [ - { - "Bearer": [] - } - ], - "tags": [ - { - "name": "intro", - "x-displayName": "Introduction", - "x-traitTag": true, - "description": "Welcome to the Koyeb API documentation.\n\nThe Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests.\nThe API has predictable resource-oriented URLs, allowing you to request, retrieve and execute actions on resources efficiently.\n\nThe API returns JSON-encoded responses and uses standard HTTP response codes, and verbs.\n\nAll of the functionality available in the Koyeb Control Panel is also available via the API, allowing you to automate repetitive and complex actions as required.\n\nAll production API requests are made to:\n\n- https://app.koyeb.com/\n\nAll data is sent and received as JSON.\n\n## Constructing Requests\n\nRequests are made of three components:\n\n- Base URL: `https://app.koyeb.com`\n- API Version: `v1`\n- Resource path: `apps`\n\nTo construct a proper request, you need to format the URL as follows:\n\n`https://app.koyeb.com/{version}/{resource}`\n\nExample: `https://app.koyeb.com/v1/apps`\n\nThe following code is an example request to retrieve the list of Apps.\n\n```\n%curl -H 'Authorization: Bearer 1111-1111-1111-1111-1111' https://app.koyeb.com/v1/apps\n{\n \"apps\": [\n {\n \"id\": \"e267e09d-a2ef-4672-95c7-bf88d787a274\",\n \"name\": \"demo\",\n \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\",\n \"updated_at\": \"2021-04-26T08:28:59.221274Z\",\n \"created_at\": \"2021-04-26T08:28:59.221274Z\",\n \"domains\": [\n {\n \"name\": \"demo-koyeb.koyeb.app\",\n \"deployment_group\": \"prod\"\n }\n ]\n },\n {\n \"id\": \"e38caea5-5acb-4fec-aa65-81749546b470\",\n \"name\": \"www\",\n \"organization_id\": \"c402bcad-d06d-4fd6-8af2-08b790c0e249\",\n \"updated_at\": \"2021-05-04T08:56:40.557792Z\",\n \"created_at\": \"2021-05-04T08:56:40.557792Z\",\n \"domains\": [\n {\n \"name\": \"www-koyeb.koyeb.app\",\n \"deployment_group\": \"prod\"\n }\n ]\n }\n ],\n \"limit\": 20,\n \"offset\": 0,\n \"count\": 2\n}\n```\n\n# Authentication\n\nThe Koyeb API uses API keys to authenticate requests. You can view and manage your API keys in the Koyeb Control Panel.\n\nYour API keys carry many privileges. Take care to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, Slack, client-side code, and so forth.\n\nTo make an authenticated request, include a bearer-type Authorization header containing your API key.\n\nAll API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.\n\n# Errors\n\nWe use conventional HTTP response codes to indicate the success or failure of an API request.\n\nIn general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g., a required parameter is missing, resource not found), and codes in the 5xx range indicate an error with our servers.\n\n## HTTP Status Code Summary\n\n- `200 OK` - Everything worked as expected.\n- `400 Bad Request` - Often missing a required parameter.\n- `401 Unauthorized` - No valid API key provided.\n- `402 Request Failed` - Parameters were valid, but the request failed.\n- `403 Forbidden` - Insufficient privileges to access the requested resource.\n- `404 Not Found` - The requested item doesn't exist.\n- `50x` Server errors - Something went wrong on the API domain's end.\n\nInput and output data must be valid JSON with the appropriate Content-Type header set.\n\n## Attributes\n\n- code:\n\n - `invalid_argument`: Occur when your request has invalid parameters.\n - `unknown_resource`: Occur when the resource doesn't exist.\n - `authentication_error`: Arise when there is a problem with authentication.\n - `rate_limit_error`: Too many requests hit the API too quickly.\n - `authorization_required`: You don't have sufficient right to access the resource.\n - `api_error`: API errors use in case of a problem with api domain's servers (extremely uncommon).\n\n- message:\n\n - A human-readable error giving more details about the error\n\n- status:\n\n - The HTTP code returned by the server.\n\n- fields (Optional):\n\n - An array of parameters with a human-readable message giving more details about the error.\n\n## Errors responses example\n\nResponse 400 (application/json)\n\n```\n{\n \"status\": 400,\n \"code\": \"invalid_argument\",\n \"message\": \"Invalid argument\",\n \"fields\": [\n {\n \"field\": \"definition.docker.image\",\n \"description\": \"cannot be blank\"\n }\n ]\n}\n```\n\nResponse 401 (application/json)\n\n```\n{\n \"status\": 401,\n \"code\": \"authentication_error\",\n \"message\": \"Request unauthenticated with bearer\"\n}\n```\n\nResponse 403 (application/json)\n\n```\n{\n \"status\": 403,\n \"code\": \"authentication_required\",\n \"message\": \"You don't have the requested permission to access to resource.\"\n}\n```\n\n\nResponse 404 (application/json)\n\n```\n{\n \"status\": 404,\n \"code\": \"unknown_resource\",\n \"message\": \"App not found\"\n}\n```\n\n# Pagination\n\nAll top-level API resources receive a paginated response. For instance, list Apps, list Services, and others share a standard structure, taking two parameters: limit and offset.\n\n**Paginated request**\n\nRequests against paginated endpoints accept two query string arguments:\n\n* *limit*, a positive integer lower or equal to 100 to select the number of items to display.\n* *offset*, an integer to indicate the position to start at.\n\nPaginated endpoints usually also accept filters to search and sort results.\nThese filters are documented along with each endpoint documentation.\n" - } - ], "x-tagGroups": [ - { - "name": "Introduction", - "tags": [ - "intro" - ] - }, { "name": "API", "tags": [ @@ -47,6 +28,7 @@ "activity", "Apps", "Services", + "ServiceViews", "Deployments", "Archives", "RegionalDeployments", @@ -7020,6 +7002,42 @@ ] } }, + "/v1/quotas/organizations/{organization_id}/{workspace_id}/quotas": { + "get": { + "operationId": "GetOrganizationWorkspaceQuotas", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/kmeta.GetOrganizationWorkspaceQuotasReply" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/google.rpc.Status" + } + } + }, + "parameters": [ + { + "name": "organization_id", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "workspace_id", + "in": "path", + "required": true, + "type": "string" + } + ], + "tags": [ + "Quotas" + ] + } + }, "/v1/search": { "get": { "summary": "Search", @@ -7782,6 +7800,108 @@ } }, "/v1/archives": { + "get": { + "summary": "List Archives", + "description": "List the archives of the organization, most recent first.", + "operationId": "ListArchives", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/ListArchivesReply" + } + }, + "400": { + "description": "Validation error", + "schema": { + "$ref": "#/definitions/ErrorWithFields" + } + }, + "401": { + "description": "Returned when the token is not valid.", + "schema": { + "$ref": "#/definitions/Error" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": { + "$ref": "#/definitions/Error" + } + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "$ref": "#/definitions/Error" + } + }, + "500": { + "description": "Returned in case of server error.", + "schema": { + "$ref": "#/definitions/Error" + } + }, + "503": { + "description": "Service is unavailable.", + "schema": { + "$ref": "#/definitions/Error" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/google.rpc.Status" + } + } + }, + "parameters": [ + { + "name": "limit", + "description": "(Optional) The number of items to return", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "offset", + "description": "(Optional) The offset in the list of items to return", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "ids", + "description": "(Optional) Filter on archive ids", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "statuses", + "description": "(Optional) Filter by archive status\n\n - ARCHIVE_STATUS_INVALID: zero value, invalid\n - ARCHIVE_STATUS_HEALTHY: the archive can be deployed and downloaded\n - ARCHIVE_STATUS_DELETING: the archive is waiting for its file to be removed\n - ARCHIVE_STATUS_DELETED: the archive and its file are deleted", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string", + "enum": [ + "ARCHIVE_STATUS_INVALID", + "ARCHIVE_STATUS_HEALTHY", + "ARCHIVE_STATUS_DELETING", + "ARCHIVE_STATUS_DELETED" + ] + }, + "collectionFormat": "multi" + } + ], + "tags": [ + "Archives" + ] + }, "post": { "summary": "Create Archive", "description": "Create a signed URL to upload an archive.", @@ -7851,15 +7971,16 @@ ] } }, - "/v1/compose": { - "post": { - "summary": "Create resources from compose.", - "operationId": "Compose", + "/v1/archives/{id}": { + "get": { + "summary": "Get Archive", + "description": "Get an archive, with a signed URL to download it.", + "operationId": "GetArchive", "responses": { "200": { "description": "A successful response.", "schema": { - "$ref": "#/definitions/ComposeReply" + "$ref": "#/definitions/GetArchiveReply" } }, "400": { @@ -7907,28 +8028,26 @@ }, "parameters": [ { - "name": "compose", - "in": "body", + "name": "id", + "description": "The id of the archive.", + "in": "path", "required": true, - "schema": { - "$ref": "#/definitions/CreateCompose" - } + "type": "string" } ], "tags": [ - "Compose" + "Archives" ] - } - }, - "/v1/deployment/{id}/scaling": { - "get": { - "summary": "Get Deployment Scaling", - "operationId": "GetDeploymentScaling", + }, + "delete": { + "summary": "Delete Archive", + "description": "Mark an archive for deletion. Its status becomes deleting, and it is\ndeleted along with its file shortly after. Deployments already built from\nit keep running, but nothing can be built from it any more.", + "operationId": "DeleteArchive", "responses": { "200": { "description": "A successful response.", "schema": { - "$ref": "#/definitions/GetDeploymentScalingReply" + "$ref": "#/definitions/DeleteArchiveReply" } }, "400": { @@ -7977,40 +8096,26 @@ "parameters": [ { "name": "id", + "description": "The id of the archive.", "in": "path", "required": true, "type": "string" - }, - { - "name": "region", - "description": "(Optional) Filter on region", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "replica_index", - "description": "(Optional) Filter on replica_index", - "in": "query", - "required": false, - "type": "integer", - "format": "int64" } ], "tags": [ - "Deployments" + "Archives" ] } }, - "/v1/deployment_events": { - "get": { - "summary": "List Deployment events", - "operationId": "ListDeploymentEvents", + "/v1/compose": { + "post": { + "summary": "Create resources from compose.", + "operationId": "Compose", "responses": { "200": { "description": "A successful response.", "schema": { - "$ref": "#/definitions/ListDeploymentEventsReply" + "$ref": "#/definitions/ComposeReply" } }, "400": { @@ -8058,59 +8163,28 @@ }, "parameters": [ { - "name": "deployment_id", - "description": "(Optional) Filter on deployment id", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "types", - "description": "(Optional) Filter on deployment event types", - "in": "query", - "required": false, - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - }, - { - "name": "limit", - "description": "(Optional) The number of items to return", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "offset", - "description": "(Optional) The offset in the list of item to return", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "order", - "description": "(Optional) Sorts the list in the ascending or the descending order", - "in": "query", - "required": false, - "type": "string" + "name": "compose", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CreateCompose" + } } ], "tags": [ - "Deployments" + "Compose" ] } }, - "/v1/deployments": { + "/v1/deployment/{id}/scaling": { "get": { - "summary": "List Deployments", - "operationId": "ListDeployments", + "summary": "Get Deployment Scaling", + "operationId": "GetDeploymentScaling", "responses": { "200": { "description": "A successful response.", "schema": { - "$ref": "#/definitions/ListDeploymentsReply" + "$ref": "#/definitions/GetDeploymentScalingReply" } }, "400": { @@ -8158,25 +8232,207 @@ }, "parameters": [ { - "name": "app_id", - "description": "(Optional) Filter on application id", - "in": "query", - "required": false, + "name": "id", + "in": "path", + "required": true, "type": "string" }, { - "name": "service_id", - "description": "(Optional) Filter on service id", + "name": "region", + "description": "(Optional) Filter on region", "in": "query", "required": false, "type": "string" }, { - "name": "limit", - "description": "(Optional) The number of items to return", + "name": "replica_index", + "description": "(Optional) Filter on replica_index", "in": "query", "required": false, - "type": "string" + "type": "integer", + "format": "int64" + } + ], + "tags": [ + "Deployments" + ] + } + }, + "/v1/deployment_events": { + "get": { + "summary": "List Deployment events", + "operationId": "ListDeploymentEvents", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/ListDeploymentEventsReply" + } + }, + "400": { + "description": "Validation error", + "schema": { + "$ref": "#/definitions/ErrorWithFields" + } + }, + "401": { + "description": "Returned when the token is not valid.", + "schema": { + "$ref": "#/definitions/Error" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": { + "$ref": "#/definitions/Error" + } + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "$ref": "#/definitions/Error" + } + }, + "500": { + "description": "Returned in case of server error.", + "schema": { + "$ref": "#/definitions/Error" + } + }, + "503": { + "description": "Service is unavailable.", + "schema": { + "$ref": "#/definitions/Error" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/google.rpc.Status" + } + } + }, + "parameters": [ + { + "name": "deployment_id", + "description": "(Optional) Filter on deployment id", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "types", + "description": "(Optional) Filter on deployment event types", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "limit", + "description": "(Optional) The number of items to return", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "offset", + "description": "(Optional) The offset in the list of item to return", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "order", + "description": "(Optional) Sorts the list in the ascending or the descending order", + "in": "query", + "required": false, + "type": "string" + } + ], + "tags": [ + "Deployments" + ] + } + }, + "/v1/deployments": { + "get": { + "summary": "List Deployments", + "operationId": "ListDeployments", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/ListDeploymentsReply" + } + }, + "400": { + "description": "Validation error", + "schema": { + "$ref": "#/definitions/ErrorWithFields" + } + }, + "401": { + "description": "Returned when the token is not valid.", + "schema": { + "$ref": "#/definitions/Error" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": { + "$ref": "#/definitions/Error" + } + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "$ref": "#/definitions/Error" + } + }, + "500": { + "description": "Returned in case of server error.", + "schema": { + "$ref": "#/definitions/Error" + } + }, + "503": { + "description": "Service is unavailable.", + "schema": { + "$ref": "#/definitions/Error" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/google.rpc.Status" + } + } + }, + "parameters": [ + { + "name": "app_id", + "description": "(Optional) Filter on application id", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "service_id", + "description": "(Optional) Filter on service id", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "limit", + "description": "(Optional) The number of items to return", + "in": "query", + "required": false, + "type": "string" }, { "name": "offset", @@ -13189,15 +13445,16 @@ ] } }, - "/v1/snapshots": { + "/v1/views/services": { "get": { - "summary": "List all Snapshots", - "operationId": "ListSnapshots", + "summary": "Query the Services view", + "description": "Unstable: this endpoint may change without notice.\n\nReturns Services with their App and Deployment state. Filters, search,\nsorting, grouping, counts and facets are all computed on the full\nauthorized result before pagination.", + "operationId": "QueryServicesView", "responses": { "200": { "description": "A successful response.", "schema": { - "$ref": "#/definitions/ListSnapshotsReply" + "$ref": "#/definitions/QueryServicesViewReply" } }, "400": { @@ -13245,55 +13502,66 @@ }, "parameters": [ { - "name": "limit", - "description": "(Optional) The number of items to return", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "offset", - "description": "(Optional) The offset in the list of item to return", + "name": "search", + "description": "(Optional) Case-insensitive search on the Service name and the App name", "in": "query", "required": false, "type": "string" }, { - "name": "organization_id", - "description": "(Optional) Filter by organization_id", + "name": "filters.types", + "description": "(Optional) Filter on Service types", "in": "query", "required": false, - "type": "string" + "type": "array", + "items": { + "type": "string", + "enum": [ + "INVALID_TYPE", + "WEB", + "WORKER", + "DATABASE", + "SANDBOX" + ] + }, + "collectionFormat": "multi" }, { - "name": "statuses", - "description": "(Optional) Filter by status\n\n - SNAPSHOT_STATUS_INVALID: zero value, invalid\n - SNAPSHOT_STATUS_CREATING: the snapshot is being created\n - SNAPSHOT_STATUS_AVAILABLE: the snapshot is complete and available\n - SNAPSHOT_STATUS_MIGRATING: the snapshot is being migrated\n - SNAPSHOT_STATUS_DELETING: the snapshot is being deleted\n - SNAPSHOT_STATUS_DELETED: the snapshot is deleted", + "name": "filters.statuses", + "description": "(Optional) Filter on Service statuses", "in": "query", "required": false, "type": "array", "items": { "type": "string", "enum": [ - "SNAPSHOT_STATUS_INVALID", - "SNAPSHOT_STATUS_CREATING", - "SNAPSHOT_STATUS_AVAILABLE", - "SNAPSHOT_STATUS_MIGRATING", - "SNAPSHOT_STATUS_DELETING", - "SNAPSHOT_STATUS_DELETED" + "STARTING", + "HEALTHY", + "DEGRADED", + "UNHEALTHY", + "DELETING", + "DELETED", + "PAUSING", + "PAUSED", + "RESUMING" ] }, "collectionFormat": "multi" }, { - "name": "region", - "description": "(Optional) A filter for the region", + "name": "filters.regions", + "description": "(Optional) Filter on regions of the latest Deployment", "in": "query", "required": false, - "type": "string" + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" }, { - "name": "ids", - "description": "(Optional) Filter on snapshot ids", + "name": "filters.app_ids", + "description": "(Optional) Filter on App ids", "in": "query", "required": false, "type": "array", @@ -13301,25 +13569,262 @@ "type": "string" }, "collectionFormat": "multi" - } - ], - "tags": [ - "Snapshots" - ] - }, - "post": { - "summary": "Create a Snapshot", - "operationId": "CreateSnapshot", - "responses": { - "200": { - "description": "A successful response.", - "schema": { - "$ref": "#/definitions/CreateSnapshotReply" - } }, - "400": { - "description": "Validation error", - "schema": { + { + "name": "filters.active_deployment_states", + "description": "(Optional) Filter on active Deployment states\n\n - SLEEPING: The active Deployment is scaled to zero and wakes up on traffic", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string", + "enum": [ + "NONE", + "STARTING", + "HEALTHY", + "DEGRADED", + "UNHEALTHY", + "STOPPING", + "PAUSED", + "SLEEPING" + ] + }, + "collectionFormat": "multi" + }, + { + "name": "filters.latest_deployment_states", + "description": "(Optional) Filter on latest Deployment states", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string", + "enum": [ + "NONE", + "STARTING", + "STOPPING", + "FAILED" + ] + }, + "collectionFormat": "multi" + }, + { + "name": "filters.needs_attention", + "description": "(Optional) Filter on Services that need attention", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "sort.field", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "CREATED_AT", + "UPDATED_AT", + "NAME", + "APP_NAME", + "ACTIVE_DEPLOYMENT_STATE", + "LATEST_DEPLOYMENT_STATE" + ], + "default": "CREATED_AT" + }, + { + "name": "sort.direction", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "ASC", + "DESC" + ], + "default": "ASC" + }, + { + "name": "group_by", + "description": "(Optional) Group rows by App. Groups are ordered by App name and keep a\nstable order across pages. Pagination always counts Services", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "NO_GROUP", + "APP" + ], + "default": "NO_GROUP" + }, + { + "name": "limit", + "description": "(Optional) The number of items to return", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "offset", + "description": "(Optional) The offset in the list of item to return", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "facets", + "description": "(Optional) Facets to compute on the full result", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string", + "enum": [ + "TYPE", + "STATUS", + "REGION", + "APP", + "ACTIVE_DEPLOYMENT_STATE", + "LATEST_DEPLOYMENT_STATE", + "NEEDS_ATTENTION" + ] + }, + "collectionFormat": "multi" + } + ], + "tags": [ + "ServiceViews" + ] + } + }, + "/v1/snapshots": { + "get": { + "summary": "List all Snapshots", + "operationId": "ListSnapshots", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/ListSnapshotsReply" + } + }, + "400": { + "description": "Validation error", + "schema": { + "$ref": "#/definitions/ErrorWithFields" + } + }, + "401": { + "description": "Returned when the token is not valid.", + "schema": { + "$ref": "#/definitions/Error" + } + }, + "403": { + "description": "Returned when the user does not have permission to access the resource.", + "schema": { + "$ref": "#/definitions/Error" + } + }, + "404": { + "description": "Returned when the resource does not exist.", + "schema": { + "$ref": "#/definitions/Error" + } + }, + "500": { + "description": "Returned in case of server error.", + "schema": { + "$ref": "#/definitions/Error" + } + }, + "503": { + "description": "Service is unavailable.", + "schema": { + "$ref": "#/definitions/Error" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/google.rpc.Status" + } + } + }, + "parameters": [ + { + "name": "limit", + "description": "(Optional) The number of items to return", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "offset", + "description": "(Optional) The offset in the list of item to return", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "organization_id", + "description": "(Optional) Filter by organization_id", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "statuses", + "description": "(Optional) Filter by status\n\n - SNAPSHOT_STATUS_INVALID: zero value, invalid\n - SNAPSHOT_STATUS_CREATING: the snapshot is being created\n - SNAPSHOT_STATUS_AVAILABLE: the snapshot is complete and available\n - SNAPSHOT_STATUS_MIGRATING: the snapshot is being migrated\n - SNAPSHOT_STATUS_DELETING: the snapshot is being deleted\n - SNAPSHOT_STATUS_DELETED: the snapshot is deleted\n - SNAPSHOT_STATUS_ERROR: the snapshot could not be created", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string", + "enum": [ + "SNAPSHOT_STATUS_INVALID", + "SNAPSHOT_STATUS_CREATING", + "SNAPSHOT_STATUS_AVAILABLE", + "SNAPSHOT_STATUS_MIGRATING", + "SNAPSHOT_STATUS_DELETING", + "SNAPSHOT_STATUS_DELETED", + "SNAPSHOT_STATUS_ERROR" + ] + }, + "collectionFormat": "multi" + }, + { + "name": "region", + "description": "(Optional) A filter for the region", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "ids", + "description": "(Optional) Filter on snapshot ids", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + } + ], + "tags": [ + "Snapshots" + ] + }, + "post": { + "summary": "Create a Snapshot", + "operationId": "CreateSnapshot", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/CreateSnapshotReply" + } + }, + "400": { + "description": "Validation error", + "schema": { "$ref": "#/definitions/ErrorWithFields" } }, @@ -16410,6 +16915,10 @@ }, "instance_snapshots": { "$ref": "#/definitions/InstanceSnapshotQuotas" + }, + "persistent_volumes_disabled": { + "type": "boolean", + "description": "When true, persistent volumes are disabled for the organization regardless\nof persistent_volumes_by_region. kaccount's ComputeQuotas omits\npersistent_volumes_by_region when this is set, so the flag must travel\nexplicitly \u2014 otherwise consumers cannot distinguish \"disabled\" from \"no\ncustom quotas\"." } } }, @@ -17476,6 +17985,14 @@ } } }, + "kmeta.GetOrganizationWorkspaceQuotasReply": { + "type": "object", + "properties": { + "quotas": { + "$ref": "#/definitions/Quotas" + } + } + }, "ksearch.App": { "type": "object", "properties": { @@ -17749,7 +18266,8 @@ "type": "object", "properties": { "delete_when_empty": { - "type": "boolean" + "type": "boolean", + "description": "If true, the app is deleted once it has no service left: either when\nits last service is deleted or, for an app that never had a service,\nonce it is older than 15 minutes." } } }, @@ -18031,9 +18549,32 @@ "type": "string", "format": "date-time", "description": "This field is automatically set by Koyeb when the\narchive is garbage collected." + }, + "download_url": { + "type": "string", + "description": "A signed URL to download the archive. Getting an archive signs a new one\nwhen it has less than 5 minutes left, valid for 24 hours." + }, + "download_url_deadline": { + "type": "string", + "format": "date-time", + "description": "When download_url expires." + }, + "status": { + "$ref": "#/definitions/ArchiveStatus" } } }, + "ArchiveStatus": { + "type": "string", + "enum": [ + "ARCHIVE_STATUS_INVALID", + "ARCHIVE_STATUS_HEALTHY", + "ARCHIVE_STATUS_DELETING", + "ARCHIVE_STATUS_DELETED" + ], + "default": "ARCHIVE_STATUS_INVALID", + "title": "- ARCHIVE_STATUS_INVALID: zero value, invalid\n - ARCHIVE_STATUS_HEALTHY: the archive can be deployed and downloaded\n - ARCHIVE_STATUS_DELETING: the archive is waiting for its file to be removed\n - ARCHIVE_STATUS_DELETED: the archive and its file are deleted" + }, "CreateArchive": { "type": "object", "properties": { @@ -18052,28 +18593,70 @@ } } }, - "BasicAuthPolicy": { + "DeleteArchiveReply": { + "type": "object" + }, + "GetArchiveReply": { "type": "object", "properties": { - "username": { - "type": "string" - }, - "password": { - "type": "string" + "archive": { + "$ref": "#/definitions/Archive" } } }, - "SecurityPolicies": { + "ListArchivesReply": { "type": "object", "properties": { - "basic_auths": { + "archives": { "type": "array", "items": { - "$ref": "#/definitions/BasicAuthPolicy" - } + "$ref": "#/definitions/Archive" + }, + "title": "The collection of archives" }, - "api_keys": { - "type": "array", + "limit": { + "type": "integer", + "format": "int64", + "title": "The limit in the request" + }, + "offset": { + "type": "integer", + "format": "int64", + "title": "The offset in the request" + }, + "count": { + "type": "integer", + "format": "int64", + "title": "The total number of archives matching the filters" + }, + "has_next": { + "type": "boolean", + "title": "If there are more items after in the collection" + } + } + }, + "BasicAuthPolicy": { + "type": "object", + "properties": { + "username": { + "type": "string" + }, + "password": { + "type": "string" + } + } + }, + "SecurityPolicies": { + "type": "object", + "properties": { + "basic_auths": { + "type": "array", + "items": { + "$ref": "#/definitions/BasicAuthPolicy" + } + }, + "api_keys": { + "type": "array", "items": { "type": "string" } @@ -18304,6 +18887,10 @@ "network_policy": { "$ref": "#/definitions/NetworkPolicy" }, + "kill_timeout_secs": { + "type": "integer", + "format": "int64" + }, "docker": { "$ref": "#/definitions/DockerSource" }, @@ -18782,6 +19369,10 @@ "credential_source": { "type": "string", "description": "Credentials can come from a specific source or default to using Github (when unset or set to \"github\")." + }, + "skip_submodules": { + "type": "boolean", + "description": "A flag to skip initializing git submodules when cloning the repository." } } }, @@ -19836,6 +20427,10 @@ }, "routing_key": { "type": "string" + }, + "internal_url": { + "type": "string", + "title": "In-cluster url of the sandbox gateway, for clients running in the same k8s cluster" } } }, @@ -20686,9 +21281,6 @@ "workspace_id": { "type": "string" }, - "customer_id": { - "type": "string" - }, "created_at": { "type": "string", "format": "date-time" @@ -20697,10 +21289,6 @@ "type": "string", "format": "date-time" }, - "released_at": { - "type": "string", - "format": "date-time" - }, "pool_generation": { "type": "string", "format": "uint64" @@ -20713,8 +21301,7 @@ "UNSPECIFIED", "PENDING", "FULFILLED", - "FAILED", - "RELEASED" + "FAILED" ], "default": "UNSPECIFIED" }, @@ -20739,7 +21326,8 @@ "type": "string" }, "request_id": { - "type": "string" + "type": "string", + "description": "Idempotency key scoped to the pool: retries with the same value return the\nsame claim. A fresh id is generated when omitted." } } }, @@ -21190,6 +21778,10 @@ "network_policy": { "$ref": "#/definitions/NetworkPolicy" }, + "kill_timeout_secs": { + "type": "integer", + "format": "int64" + }, "docker": { "$ref": "#/definitions/DockerSource" }, @@ -21701,9 +22293,6 @@ "generation": { "type": "string", "format": "uint64" - }, - "customer_id": { - "type": "string" } } }, @@ -22045,6 +22634,384 @@ "type": "object", "title": "Empty reply - success is indicated by no error" }, + "QueryServicesViewFilters": { + "type": "object", + "properties": { + "types": { + "type": "array", + "items": { + "$ref": "#/definitions/Service.Type" + }, + "title": "(Optional) Filter on Service types" + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/definitions/Service.Status" + }, + "title": "(Optional) Filter on Service statuses" + }, + "regions": { + "type": "array", + "items": { + "type": "string" + }, + "title": "(Optional) Filter on regions of the latest Deployment" + }, + "app_ids": { + "type": "array", + "items": { + "type": "string" + }, + "title": "(Optional) Filter on App ids" + }, + "active_deployment_states": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceViewActiveDeployment.State" + }, + "title": "(Optional) Filter on active Deployment states" + }, + "latest_deployment_states": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceViewLatestDeployment.State" + }, + "title": "(Optional) Filter on latest Deployment states" + }, + "needs_attention": { + "type": "boolean", + "title": "(Optional) Filter on Services that need attention" + } + } + }, + "QueryServicesViewReply": { + "type": "object", + "properties": { + "services": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceViewRow" + } + }, + "groups": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceViewGroup" + }, + "title": "Groups present in this page, with counts computed on the full result" + }, + "facets": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceViewFacet" + }, + "title": "Facets computed on the full result, ignoring the filter on the facet itself" + }, + "limit": { + "type": "integer", + "format": "int64", + "title": "The limit in the request" + }, + "offset": { + "type": "integer", + "format": "int64", + "title": "The offset in the request" + }, + "count": { + "type": "integer", + "format": "int64", + "title": "The total number of Services matching the query" + }, + "has_next": { + "type": "boolean", + "title": "If there is more items after in the collection" + } + } + }, + "QueryServicesViewSort": { + "type": "object", + "properties": { + "field": { + "$ref": "#/definitions/QueryServicesViewSort.Field" + }, + "direction": { + "$ref": "#/definitions/QueryServicesViewSort.Direction" + } + } + }, + "QueryServicesViewSort.Direction": { + "type": "string", + "enum": [ + "ASC", + "DESC" + ], + "default": "ASC" + }, + "QueryServicesViewSort.Field": { + "type": "string", + "enum": [ + "CREATED_AT", + "UPDATED_AT", + "NAME", + "APP_NAME", + "ACTIVE_DEPLOYMENT_STATE", + "LATEST_DEPLOYMENT_STATE" + ], + "default": "CREATED_AT", + "title": "ACTIVE_DEPLOYMENT_STATE and LATEST_DEPLOYMENT_STATE sort by severity, the\nmost urgent first in ascending order. NONE states are always last" + }, + "ServiceViewActiveDeployment": { + "type": "object", + "properties": { + "state": { + "$ref": "#/definitions/ServiceViewActiveDeployment.State" + }, + "id": { + "type": "string", + "title": "Unset when the Service has no active Deployment" + }, + "missing": { + "type": "boolean", + "title": "True when the Service references an active Deployment that cannot be found" + }, + "status": { + "$ref": "#/definitions/Deployment.Status" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + }, + "ServiceViewActiveDeployment.State": { + "type": "string", + "enum": [ + "NONE", + "STARTING", + "HEALTHY", + "DEGRADED", + "UNHEALTHY", + "STOPPING", + "PAUSED", + "SLEEPING" + ], + "default": "NONE", + "description": "- SLEEPING: The active Deployment is scaled to zero and wakes up on traffic", + "title": "The Deployment currently serving the Service, from the product point of view" + }, + "ServiceViewApp": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + } + } + }, + "ServiceViewFacet": { + "type": "object", + "properties": { + "kind": { + "$ref": "#/definitions/ServiceViewFacet.Kind" + }, + "values": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceViewFacet.Value" + } + } + } + }, + "ServiceViewFacet.Kind": { + "type": "string", + "enum": [ + "TYPE", + "STATUS", + "REGION", + "APP", + "ACTIVE_DEPLOYMENT_STATE", + "LATEST_DEPLOYMENT_STATE", + "NEEDS_ATTENTION" + ], + "default": "TYPE" + }, + "ServiceViewFacet.Value": { + "type": "object", + "properties": { + "value": { + "type": "string", + "title": "The value to use in the matching filter" + }, + "label": { + "type": "string", + "title": "A display label when the value is an identifier, e.g. the App name" + }, + "count": { + "type": "integer", + "format": "int64" + } + } + }, + "ServiceViewGroup": { + "type": "object", + "properties": { + "by": { + "$ref": "#/definitions/ServiceViewGroup.By" + }, + "key": { + "type": "string", + "title": "The group key, e.g. the App id" + }, + "label": { + "type": "string", + "title": "The group label, e.g. the App name" + }, + "count": { + "type": "integer", + "format": "int64", + "title": "The number of Services of this group matching the query" + } + } + }, + "ServiceViewGroup.By": { + "type": "string", + "enum": [ + "NO_GROUP", + "APP" + ], + "default": "NO_GROUP" + }, + "ServiceViewLatestDeployment": { + "type": "object", + "properties": { + "state": { + "$ref": "#/definitions/ServiceViewLatestDeployment.State" + }, + "id": { + "type": "string", + "title": "Unset when the Service has no latest Deployment" + }, + "missing": { + "type": "boolean", + "title": "True when the Service references a latest Deployment that cannot be found" + }, + "status": { + "$ref": "#/definitions/Deployment.Status" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + }, + "ServiceViewLatestDeployment.State": { + "type": "string", + "enum": [ + "NONE", + "STARTING", + "STOPPING", + "FAILED" + ], + "default": "NONE", + "title": "The state of the latest Deployment when it differs from the active one" + }, + "ServiceViewRow": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "type": { + "$ref": "#/definitions/Service.Type" + }, + "status": { + "$ref": "#/definitions/Service.Status" + }, + "messages": { + "type": "array", + "items": { + "type": "string" + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "app_id": { + "type": "string" + }, + "app": { + "$ref": "#/definitions/ServiceViewApp", + "title": "The App of the Service" + }, + "active_deployment": { + "$ref": "#/definitions/ServiceViewActiveDeployment" + }, + "latest_deployment": { + "$ref": "#/definitions/ServiceViewLatestDeployment" + }, + "needs_attention": { + "type": "boolean", + "title": "True when the active Deployment state is UNHEALTHY or DEGRADED, or the latest Deployment state is FAILED" + }, + "regions": { + "type": "array", + "items": { + "type": "string" + }, + "title": "Regions of the latest Deployment" + }, + "instance_type": { + "type": "string", + "title": "Instance type of the latest Deployment" + }, + "source": { + "$ref": "#/definitions/ServiceViewSource", + "title": "Source of the latest Deployment" + } + } + }, + "ServiceViewSource": { + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/ServiceViewSource.Type" + }, + "reference": { + "type": "string", + "title": "The docker image or the git repository" + } + } + }, + "ServiceViewSource.Type": { + "type": "string", + "enum": [ + "UNKNOWN", + "DOCKER", + "GIT", + "ARCHIVE", + "DATABASE" + ], + "default": "UNKNOWN" + }, "CreateSnapshotReply": { "type": "object", "properties": { @@ -22170,10 +23137,11 @@ "SNAPSHOT_STATUS_AVAILABLE", "SNAPSHOT_STATUS_MIGRATING", "SNAPSHOT_STATUS_DELETING", - "SNAPSHOT_STATUS_DELETED" + "SNAPSHOT_STATUS_DELETED", + "SNAPSHOT_STATUS_ERROR" ], "default": "SNAPSHOT_STATUS_INVALID", - "title": "- SNAPSHOT_STATUS_INVALID: zero value, invalid\n - SNAPSHOT_STATUS_CREATING: the snapshot is being created\n - SNAPSHOT_STATUS_AVAILABLE: the snapshot is complete and available\n - SNAPSHOT_STATUS_MIGRATING: the snapshot is being migrated\n - SNAPSHOT_STATUS_DELETING: the snapshot is being deleted\n - SNAPSHOT_STATUS_DELETED: the snapshot is deleted" + "title": "- SNAPSHOT_STATUS_INVALID: zero value, invalid\n - SNAPSHOT_STATUS_CREATING: the snapshot is being created\n - SNAPSHOT_STATUS_AVAILABLE: the snapshot is complete and available\n - SNAPSHOT_STATUS_MIGRATING: the snapshot is being migrated\n - SNAPSHOT_STATUS_DELETING: the snapshot is being deleted\n - SNAPSHOT_STATUS_DELETED: the snapshot is deleted\n - SNAPSHOT_STATUS_ERROR: the snapshot could not be created" }, "SnapshotType": { "type": "string", @@ -22645,7 +23613,13 @@ "Bearer": { "type": "apiKey", "name": "Authorization", - "in": "header" + "in": "header", + "description": "API key passed as a bearer token. The header value must be prefixed with `Bearer `, e.g. `Authorization: Bearer `.\n" + } + }, + "security": [ + { + "Bearer": [] } - } + ] } \ No newline at end of file