From a54d700e36daa51da4924eabdbe9c8589a96d01c Mon Sep 17 00:00:00 2001 From: scaleway-bot Date: Mon, 31 Mar 2025 10:11:34 +0000 Subject: [PATCH] feat: update generated APIs --- packages/clients/src/api/account/index.gen.ts | 4 +- .../clients/src/api/account/v3/index.gen.ts | 5 +- .../clients/src/api/applesilicon/index.gen.ts | 4 +- .../api/applesilicon/v1alpha1/index.gen.ts | 5 +- .../clients/src/api/audit_trail/index.gen.ts | 4 +- .../clients/src/api/baremetal/index.gen.ts | 4 +- .../clients/src/api/baremetal/v1/index.gen.ts | 5 +- packages/clients/src/api/billing/index.gen.ts | 4 +- packages/clients/src/api/block/index.gen.ts | 4 +- packages/clients/src/api/cockpit/index.gen.ts | 4 +- .../clients/src/api/cockpit/v1/index.gen.ts | 5 +- .../clients/src/api/container/index.gen.ts | 4 +- packages/clients/src/api/dedibox/index.gen.ts | 4 +- .../clients/src/api/document_db/index.gen.ts | 4 +- packages/clients/src/api/domain/index.gen.ts | 4 +- .../src/api/domain/v2beta1/index.gen.ts | 5 +- .../src/api/edge_services/index.gen.ts | 4 +- .../clients/src/api/flexibleip/index.gen.ts | 4 +- .../clients/src/api/function/index.gen.ts | 4 +- packages/clients/src/api/iam/index.gen.ts | 4 +- packages/clients/src/api/index.gen.ts | 4 +- .../clients/src/api/inference/index.gen.ts | 4 +- .../clients/src/api/instance/index.gen.ts | 4 +- .../clients/src/api/interlink/index.gen.ts | 4 +- packages/clients/src/api/iot/index.gen.ts | 4 +- packages/clients/src/api/ipam/index.gen.ts | 4 +- packages/clients/src/api/ipfs/index.gen.ts | 4 +- packages/clients/src/api/jobs/index.gen.ts | 4 +- packages/clients/src/api/k8s/index.gen.ts | 4 +- .../clients/src/api/key_manager/index.gen.ts | 4 +- packages/clients/src/api/lb/index.gen.ts | 4 +- packages/clients/src/api/lb/v1/api.gen.ts | 244 +- packages/clients/src/api/lb/v1/index.gen.ts | 5 +- .../clients/src/api/lb/v1/marshalling.gen.ts | 9 + packages/clients/src/api/lb/v1/types.gen.ts | 2950 ++++++++++------- .../src/api/llm_inference/index.gen.ts | 4 +- .../clients/src/api/marketplace/index.gen.ts | 4 +- packages/clients/src/api/mnq/index.gen.ts | 4 +- .../clients/src/api/mnq/v1beta1/index.gen.ts | 6 +- packages/clients/src/api/mongodb/index.gen.ts | 4 +- packages/clients/src/api/qaas/index.gen.ts | 4 +- packages/clients/src/api/rdb/index.gen.ts | 4 +- packages/clients/src/api/redis/index.gen.ts | 4 +- .../clients/src/api/registry/index.gen.ts | 4 +- packages/clients/src/api/secret/index.gen.ts | 4 +- .../src/api/serverless_sqldb/index.gen.ts | 4 +- packages/clients/src/api/tem/index.gen.ts | 4 +- packages/clients/src/api/test/index.gen.ts | 4 +- packages/clients/src/api/vpc/index.gen.ts | 4 +- packages/clients/src/api/vpcgw/index.gen.ts | 4 +- .../clients/src/api/webhosting/index.gen.ts | 4 +- 51 files changed, 2021 insertions(+), 1382 deletions(-) diff --git a/packages/clients/src/api/account/index.gen.ts b/packages/clients/src/api/account/index.gen.ts index 1b3f55320..333d11779 100644 --- a/packages/clients/src/api/account/index.gen.ts +++ b/packages/clients/src/api/account/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v2 from './v2/index.gen' diff --git a/packages/clients/src/api/account/v3/index.gen.ts b/packages/clients/src/api/account/v3/index.gen.ts index 602eeae7d..dd72dadae 100644 --- a/packages/clients/src/api/account/v3/index.gen.ts +++ b/packages/clients/src/api/account/v3/index.gen.ts @@ -1,6 +1,9 @@ // This file was automatically generated. DO NOT EDIT. // If you have any remark or suggestion do not hesitate to open an issue. -export { ContractAPI, ProjectAPI } from './api.gen' +export { + ContractAPI, + ProjectAPI, +} from './api.gen' export type { CheckContractSignatureResponse, Contract, diff --git a/packages/clients/src/api/applesilicon/index.gen.ts b/packages/clients/src/api/applesilicon/index.gen.ts index 6dec29b44..4e5e04061 100644 --- a/packages/clients/src/api/applesilicon/index.gen.ts +++ b/packages/clients/src/api/applesilicon/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1alpha1 from './v1alpha1/index.gen' diff --git a/packages/clients/src/api/applesilicon/v1alpha1/index.gen.ts b/packages/clients/src/api/applesilicon/v1alpha1/index.gen.ts index 2fef6a0c1..2234c5055 100644 --- a/packages/clients/src/api/applesilicon/v1alpha1/index.gen.ts +++ b/packages/clients/src/api/applesilicon/v1alpha1/index.gen.ts @@ -1,6 +1,9 @@ // This file was automatically generated. DO NOT EDIT. // If you have any remark or suggestion do not hesitate to open an issue. -export { API, PrivateNetworkAPI } from './api.gen' +export { + API, + PrivateNetworkAPI, +} from './api.gen' export * from './content.gen' export type { Commitment, diff --git a/packages/clients/src/api/audit_trail/index.gen.ts b/packages/clients/src/api/audit_trail/index.gen.ts index 6dec29b44..4e5e04061 100644 --- a/packages/clients/src/api/audit_trail/index.gen.ts +++ b/packages/clients/src/api/audit_trail/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1alpha1 from './v1alpha1/index.gen' diff --git a/packages/clients/src/api/baremetal/index.gen.ts b/packages/clients/src/api/baremetal/index.gen.ts index 81bee1055..66600f8ba 100644 --- a/packages/clients/src/api/baremetal/index.gen.ts +++ b/packages/clients/src/api/baremetal/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1 from './v1/index' diff --git a/packages/clients/src/api/baremetal/v1/index.gen.ts b/packages/clients/src/api/baremetal/v1/index.gen.ts index fff7d779f..025e18a7a 100644 --- a/packages/clients/src/api/baremetal/v1/index.gen.ts +++ b/packages/clients/src/api/baremetal/v1/index.gen.ts @@ -1,6 +1,9 @@ // This file was automatically generated. DO NOT EDIT. // If you have any remark or suggestion do not hesitate to open an issue. -export { API, PrivateNetworkAPI } from './api.gen' +export { + API, + PrivateNetworkAPI, +} from './api.gen' export * from './content.gen' export type { AddOptionServerRequest, diff --git a/packages/clients/src/api/billing/index.gen.ts b/packages/clients/src/api/billing/index.gen.ts index 35a5f69ed..151c81ecc 100644 --- a/packages/clients/src/api/billing/index.gen.ts +++ b/packages/clients/src/api/billing/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v2alpha1 from './v2alpha1/index.gen' diff --git a/packages/clients/src/api/block/index.gen.ts b/packages/clients/src/api/block/index.gen.ts index 3c605af8e..abe7c4339 100644 --- a/packages/clients/src/api/block/index.gen.ts +++ b/packages/clients/src/api/block/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1 from './v1/index.gen' diff --git a/packages/clients/src/api/cockpit/index.gen.ts b/packages/clients/src/api/cockpit/index.gen.ts index 5fbe167b7..a7faa1b20 100644 --- a/packages/clients/src/api/cockpit/index.gen.ts +++ b/packages/clients/src/api/cockpit/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1 from './v1/index.gen' diff --git a/packages/clients/src/api/cockpit/v1/index.gen.ts b/packages/clients/src/api/cockpit/v1/index.gen.ts index 36ef92f90..443477b24 100644 --- a/packages/clients/src/api/cockpit/v1/index.gen.ts +++ b/packages/clients/src/api/cockpit/v1/index.gen.ts @@ -1,6 +1,9 @@ // This file was automatically generated. DO NOT EDIT. // If you have any remark or suggestion do not hesitate to open an issue. -export { GlobalAPI, RegionalAPI } from './api.gen' +export { + GlobalAPI, + RegionalAPI, +} from './api.gen' export type { Alert, AlertManager, diff --git a/packages/clients/src/api/container/index.gen.ts b/packages/clients/src/api/container/index.gen.ts index 886270369..79692e383 100644 --- a/packages/clients/src/api/container/index.gen.ts +++ b/packages/clients/src/api/container/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1beta1 from './v1beta1/index.gen' diff --git a/packages/clients/src/api/dedibox/index.gen.ts b/packages/clients/src/api/dedibox/index.gen.ts index a86d42c0b..aff657f1e 100644 --- a/packages/clients/src/api/dedibox/index.gen.ts +++ b/packages/clients/src/api/dedibox/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1 from './v1/index.gen' diff --git a/packages/clients/src/api/document_db/index.gen.ts b/packages/clients/src/api/document_db/index.gen.ts index 886270369..79692e383 100644 --- a/packages/clients/src/api/document_db/index.gen.ts +++ b/packages/clients/src/api/document_db/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1beta1 from './v1beta1/index.gen' diff --git a/packages/clients/src/api/domain/index.gen.ts b/packages/clients/src/api/domain/index.gen.ts index b4fd0db98..20241ec7a 100644 --- a/packages/clients/src/api/domain/index.gen.ts +++ b/packages/clients/src/api/domain/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v2beta1 from './v2beta1/index.gen' diff --git a/packages/clients/src/api/domain/v2beta1/index.gen.ts b/packages/clients/src/api/domain/v2beta1/index.gen.ts index 10fdd848e..228732a9e 100644 --- a/packages/clients/src/api/domain/v2beta1/index.gen.ts +++ b/packages/clients/src/api/domain/v2beta1/index.gen.ts @@ -1,6 +1,9 @@ // This file was automatically generated. DO NOT EDIT. // If you have any remark or suggestion do not hesitate to open an issue. -export { API, RegistrarAPI } from './api.gen' +export { + API, + RegistrarAPI, +} from './api.gen' export * from './content.gen' export type { AvailableDomain, diff --git a/packages/clients/src/api/edge_services/index.gen.ts b/packages/clients/src/api/edge_services/index.gen.ts index 72d281d6b..6a15a4900 100644 --- a/packages/clients/src/api/edge_services/index.gen.ts +++ b/packages/clients/src/api/edge_services/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1alpha1 from './v1alpha1/index.gen' diff --git a/packages/clients/src/api/flexibleip/index.gen.ts b/packages/clients/src/api/flexibleip/index.gen.ts index 6dec29b44..4e5e04061 100644 --- a/packages/clients/src/api/flexibleip/index.gen.ts +++ b/packages/clients/src/api/flexibleip/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1alpha1 from './v1alpha1/index.gen' diff --git a/packages/clients/src/api/function/index.gen.ts b/packages/clients/src/api/function/index.gen.ts index 886270369..79692e383 100644 --- a/packages/clients/src/api/function/index.gen.ts +++ b/packages/clients/src/api/function/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1beta1 from './v1beta1/index.gen' diff --git a/packages/clients/src/api/iam/index.gen.ts b/packages/clients/src/api/iam/index.gen.ts index 6dec29b44..4e5e04061 100644 --- a/packages/clients/src/api/iam/index.gen.ts +++ b/packages/clients/src/api/iam/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1alpha1 from './v1alpha1/index.gen' diff --git a/packages/clients/src/api/index.gen.ts b/packages/clients/src/api/index.gen.ts index b4c0be94c..9ad0f77af 100644 --- a/packages/clients/src/api/index.gen.ts +++ b/packages/clients/src/api/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ import * as Account from './account/index.gen' diff --git a/packages/clients/src/api/inference/index.gen.ts b/packages/clients/src/api/inference/index.gen.ts index 5fbe167b7..a7faa1b20 100644 --- a/packages/clients/src/api/inference/index.gen.ts +++ b/packages/clients/src/api/inference/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1 from './v1/index.gen' diff --git a/packages/clients/src/api/instance/index.gen.ts b/packages/clients/src/api/instance/index.gen.ts index 552427430..7b9ae965b 100644 --- a/packages/clients/src/api/instance/index.gen.ts +++ b/packages/clients/src/api/instance/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1 from './v1/index' diff --git a/packages/clients/src/api/interlink/index.gen.ts b/packages/clients/src/api/interlink/index.gen.ts index 886270369..79692e383 100644 --- a/packages/clients/src/api/interlink/index.gen.ts +++ b/packages/clients/src/api/interlink/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1beta1 from './v1beta1/index.gen' diff --git a/packages/clients/src/api/iot/index.gen.ts b/packages/clients/src/api/iot/index.gen.ts index a86d42c0b..aff657f1e 100644 --- a/packages/clients/src/api/iot/index.gen.ts +++ b/packages/clients/src/api/iot/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1 from './v1/index.gen' diff --git a/packages/clients/src/api/ipam/index.gen.ts b/packages/clients/src/api/ipam/index.gen.ts index a86d42c0b..aff657f1e 100644 --- a/packages/clients/src/api/ipam/index.gen.ts +++ b/packages/clients/src/api/ipam/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1 from './v1/index.gen' diff --git a/packages/clients/src/api/ipfs/index.gen.ts b/packages/clients/src/api/ipfs/index.gen.ts index 6dec29b44..4e5e04061 100644 --- a/packages/clients/src/api/ipfs/index.gen.ts +++ b/packages/clients/src/api/ipfs/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1alpha1 from './v1alpha1/index.gen' diff --git a/packages/clients/src/api/jobs/index.gen.ts b/packages/clients/src/api/jobs/index.gen.ts index 6dec29b44..4e5e04061 100644 --- a/packages/clients/src/api/jobs/index.gen.ts +++ b/packages/clients/src/api/jobs/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1alpha1 from './v1alpha1/index.gen' diff --git a/packages/clients/src/api/k8s/index.gen.ts b/packages/clients/src/api/k8s/index.gen.ts index 552427430..7b9ae965b 100644 --- a/packages/clients/src/api/k8s/index.gen.ts +++ b/packages/clients/src/api/k8s/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1 from './v1/index' diff --git a/packages/clients/src/api/key_manager/index.gen.ts b/packages/clients/src/api/key_manager/index.gen.ts index 6dec29b44..4e5e04061 100644 --- a/packages/clients/src/api/key_manager/index.gen.ts +++ b/packages/clients/src/api/key_manager/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1alpha1 from './v1alpha1/index.gen' diff --git a/packages/clients/src/api/lb/index.gen.ts b/packages/clients/src/api/lb/index.gen.ts index 552427430..7b9ae965b 100644 --- a/packages/clients/src/api/lb/index.gen.ts +++ b/packages/clients/src/api/lb/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1 from './v1/index' diff --git a/packages/clients/src/api/lb/v1/api.gen.ts b/packages/clients/src/api/lb/v1/api.gen.ts index e7ed01906..ed125ba72 100644 --- a/packages/clients/src/api/lb/v1/api.gen.ts +++ b/packages/clients/src/api/lb/v1/api.gen.ts @@ -50,6 +50,7 @@ import { marshalZonedApiCreateLbRequest, marshalZonedApiCreateRouteRequest, marshalZonedApiCreateSubscriberRequest, + marshalZonedApiDetachPrivateNetworkRequest, marshalZonedApiMigrateLbRequest, marshalZonedApiRemoveBackendServersRequest, marshalZonedApiSetAclsRequest, @@ -227,8 +228,8 @@ const jsonContentHeaders = { /** * Load Balancer API. - * - * This API allows you to manage your Scaleway Load Balancer services. + +This API allows you to manage your Scaleway Load Balancer services. */ export class ZonedAPI extends ParentAPI { /** Lists the available zones of the API. */ @@ -265,10 +266,7 @@ export class ZonedAPI extends ParentAPI { ) /** - * List Load Balancers. List all Load Balancers in the specified zone, for a - * Scaleway Organization or Scaleway Project. By default, the Load Balancers - * returned in the list are ordered by creation date in ascending order, - * though this can be modified via the `order_by` field. + * List Load Balancers. List all Load Balancers in the specified zone, for a Scaleway Organization or Scaleway Project. By default, the Load Balancers returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field. * * @param request - The request {@link ZonedApiListLbsRequest} * @returns A Promise of ListLbsResponse @@ -277,9 +275,7 @@ export class ZonedAPI extends ParentAPI { enrichForPagination('lbs', this.pageOfListLbs, request) /** - * Create a Load Balancer. Create a new Load Balancer. Note that the Load - * Balancer will be created without frontends or backends; these must be - * created separately via the dedicated endpoints. + * Create a Load Balancer. Create a new Load Balancer. Note that the Load Balancer will be created without frontends or backends; these must be created separately via the dedicated endpoints. * * @param request - The request {@link ZonedApiCreateLbRequest} * @returns A Promise of Lb @@ -298,9 +294,7 @@ export class ZonedAPI extends ParentAPI { ) /** - * Get a Load Balancer. Retrieve information about an existing Load Balancer, - * specified by its Load Balancer ID. Its full details, including name, status - * and IP address, are returned in the response object. + * Get a Load Balancer. Retrieve information about an existing Load Balancer, specified by its Load Balancer ID. Its full details, including name, status and IP address, are returned in the response object. * * @param request - The request {@link ZonedApiGetLbRequest} * @returns A Promise of Lb @@ -335,9 +329,7 @@ export class ZonedAPI extends ParentAPI { ) /** - * Update a Load Balancer. Update the parameters of an existing Load Balancer, - * specified by its Load Balancer ID. Note that the request type is PUT and - * not PATCH. You must set all parameters. + * Update a Load Balancer. Update the parameters of an existing Load Balancer, specified by its Load Balancer ID. Note that the request type is PUT and not PATCH. You must set all parameters. * * @param request - The request {@link ZonedApiUpdateLbRequest} * @returns A Promise of Lb @@ -356,10 +348,7 @@ export class ZonedAPI extends ParentAPI { ) /** - * Delete a Load Balancer. Delete an existing Load Balancer, specified by its - * Load Balancer ID. Deleting a Load Balancer is permanent, and cannot be - * undone. The Load Balancer's flexible IP address can either be deleted with - * the Load Balancer, or kept in your account for future use. + * Delete a Load Balancer. Delete an existing Load Balancer, specified by its Load Balancer ID. Deleting a Load Balancer is permanent, and cannot be undone. The Load Balancer's flexible IP address can either be deleted with the Load Balancer, or kept in your account for future use. * * @param request - The request {@link ZonedApiDeleteLbRequest} */ @@ -371,9 +360,7 @@ export class ZonedAPI extends ParentAPI { }) /** - * Migrate a Load Balancer. Migrate an existing Load Balancer from one - * commercial type to another. Allows you to scale your Load Balancer up or - * down in terms of bandwidth or multi-cloud provision. + * Migrate a Load Balancer. Migrate an existing Load Balancer from one commercial type to another. Allows you to scale your Load Balancer up or down in terms of bandwidth or multi-cloud provision. * * @param request - The request {@link ZonedApiMigrateLbRequest} * @returns A Promise of Lb @@ -413,9 +400,7 @@ export class ZonedAPI extends ParentAPI { ) /** - * List IP addresses. List the Load Balancer flexible IP addresses held in the - * account (filtered by Organization ID or Project ID). It is also possible to - * search for a specific IP address. + * List IP addresses. List the Load Balancer flexible IP addresses held in the account (filtered by Organization ID or Project ID). It is also possible to search for a specific IP address. * * @param request - The request {@link ZonedApiListIPsRequest} * @returns A Promise of ListIpsResponse @@ -424,9 +409,7 @@ export class ZonedAPI extends ParentAPI { enrichForPagination('ips', this.pageOfListIPs, request) /** - * Create an IP address. Create a new Load Balancer flexible IP address, in - * the specified Scaleway Project. This can be attached to new Load Balancers - * created in the future. + * Create an IP address. Create a new Load Balancer flexible IP address, in the specified Scaleway Project. This can be attached to new Load Balancers created in the future. * * @param request - The request {@link ZonedApiCreateIpRequest} * @returns A Promise of Ip @@ -445,8 +428,7 @@ export class ZonedAPI extends ParentAPI { ) /** - * Get an IP address. Retrieve the full details of a Load Balancer flexible IP - * address. + * Get an IP address. Retrieve the full details of a Load Balancer flexible IP address. * * @param request - The request {@link ZonedApiGetIpRequest} * @returns A Promise of Ip @@ -461,8 +443,7 @@ export class ZonedAPI extends ParentAPI { ) /** - * Delete an IP address. Delete a Load Balancer flexible IP address. This - * action is irreversible, and cannot be undone. + * Delete an IP address. Delete a Load Balancer flexible IP address. This action is irreversible, and cannot be undone. * * @param request - The request {@link ZonedApiReleaseIpRequest} */ @@ -473,8 +454,7 @@ export class ZonedAPI extends ParentAPI { }) /** - * Update an IP address. Update the reverse DNS of a Load Balancer flexible IP - * address. + * Update an IP address. Update the reverse DNS of a Load Balancer flexible IP address. * * @param request - The request {@link ZonedApiUpdateIpRequest} * @returns A Promise of Ip @@ -513,12 +493,7 @@ export class ZonedAPI extends ParentAPI { ) /** - * List the backends of a given Load Balancer. List all the backends of a Load - * Balancer, specified by its Load Balancer ID. By default, results are - * returned in ascending order by the creation date of each backend. The - * response is an array of backend objects, containing full details of each - * one including their configuration parameters such as protocol, port and - * forwarding algorithm. + * List the backends of a given Load Balancer. List all the backends of a Load Balancer, specified by its Load Balancer ID. By default, results are returned in ascending order by the creation date of each backend. The response is an array of backend objects, containing full details of each one including their configuration parameters such as protocol, port and forwarding algorithm. * * @param request - The request {@link ZonedApiListBackendsRequest} * @returns A Promise of ListBackendsResponse @@ -527,9 +502,7 @@ export class ZonedAPI extends ParentAPI { enrichForPagination('backends', this.pageOfListBackends, request) /** - * Create a backend for a given Load Balancer. Create a new backend for a - * given Load Balancer, specifying its full configuration including protocol, - * port and forwarding algorithm. + * Create a backend for a given Load Balancer. Create a new backend for a given Load Balancer, specifying its full configuration including protocol, port and forwarding algorithm. * * @param request - The request {@link ZonedApiCreateBackendRequest} * @returns A Promise of Backend @@ -548,10 +521,7 @@ export class ZonedAPI extends ParentAPI { ) /** - * Get a backend of a given Load Balancer. Get the full details of a given - * backend, specified by its backend ID. The response contains the backend's - * full configuration parameters including protocol, port and forwarding - * algorithm. + * Get a backend of a given Load Balancer. Get the full details of a given backend, specified by its backend ID. The response contains the backend's full configuration parameters including protocol, port and forwarding algorithm. * * @param request - The request {@link ZonedApiGetBackendRequest} * @returns A Promise of Backend @@ -566,9 +536,7 @@ export class ZonedAPI extends ParentAPI { ) /** - * Update a backend of a given Load Balancer. Update a backend of a given Load - * Balancer, specified by its backend ID. Note that the request type is PUT - * and not PATCH. You must set all parameters. + * Update a backend of a given Load Balancer. Update a backend of a given Load Balancer, specified by its backend ID. Note that the request type is PUT and not PATCH. You must set all parameters. * * @param request - The request {@link ZonedApiUpdateBackendRequest} * @returns A Promise of Backend @@ -587,9 +555,7 @@ export class ZonedAPI extends ParentAPI { ) /** - * Delete a backend of a given Load Balancer. Delete a backend of a given Load - * Balancer, specified by its backend ID. This action is irreversible and - * cannot be undone. + * Delete a backend of a given Load Balancer. Delete a backend of a given Load Balancer, specified by its backend ID. This action is irreversible and cannot be undone. * * @param request - The request {@link ZonedApiDeleteBackendRequest} */ @@ -600,10 +566,7 @@ export class ZonedAPI extends ParentAPI { }) /** - * Add a set of backend servers to a given backend. For a given backend - * specified by its backend ID, add a set of backend servers (identified by - * their IP addresses) it should forward traffic to. These will be appended to - * any existing set of backend servers for this backend. + * Add a set of backend servers to a given backend. For a given backend specified by its backend ID, add a set of backend servers (identified by their IP addresses) it should forward traffic to. These will be appended to any existing set of backend servers for this backend. * * @param request - The request {@link ZonedApiAddBackendServersRequest} * @returns A Promise of Backend @@ -625,9 +588,7 @@ export class ZonedAPI extends ParentAPI { ) /** - * Remove a set of servers for a given backend. For a given backend specified - * by its backend ID, remove the specified backend servers (identified by - * their IP addresses) so that it no longer forwards traffic to them. + * Remove a set of servers for a given backend. For a given backend specified by its backend ID, remove the specified backend servers (identified by their IP addresses) so that it no longer forwards traffic to them. * * @param request - The request {@link ZonedApiRemoveBackendServersRequest} * @returns A Promise of Backend @@ -651,10 +612,7 @@ export class ZonedAPI extends ParentAPI { ) /** - * Define all backend servers for a given backend. For a given backend - * specified by its backend ID, define the set of backend servers (identified - * by their IP addresses) that it should forward traffic to. Any existing - * backend servers configured for this backend will be removed. + * Define all backend servers for a given backend. For a given backend specified by its backend ID, define the set of backend servers (identified by their IP addresses) that it should forward traffic to. Any existing backend servers configured for this backend will be removed. * * @param request - The request {@link ZonedApiSetBackendServersRequest} * @returns A Promise of Backend @@ -676,10 +634,7 @@ export class ZonedAPI extends ParentAPI { ) /** - * Update a health check for a given backend. Update the configuration of the - * health check performed by a given backend to verify the health of its - * backend servers, identified by its backend ID. Note that the request type - * is PUT and not PATCH. You must set all parameters. + * Update a health check for a given backend. Update the configuration of the health check performed by a given backend to verify the health of its backend servers, identified by its backend ID. Note that the request type is PUT and not PATCH. You must set all parameters. * * @param request - The request {@link ZonedApiUpdateHealthCheckRequest} * @returns A Promise of HealthCheck @@ -721,12 +676,7 @@ export class ZonedAPI extends ParentAPI { ) /** - * List frontends of a given Load Balancer. List all the frontends of a Load - * Balancer, specified by its Load Balancer ID. By default, results are - * returned in ascending order by the creation date of each frontend. The - * response is an array of frontend objects, containing full details of each - * one including the port they listen on and the backend they are attached - * to. + * List frontends of a given Load Balancer. List all the frontends of a Load Balancer, specified by its Load Balancer ID. By default, results are returned in ascending order by the creation date of each frontend. The response is an array of frontend objects, containing full details of each one including the port they listen on and the backend they are attached to. * * @param request - The request {@link ZonedApiListFrontendsRequest} * @returns A Promise of ListFrontendsResponse @@ -735,9 +685,7 @@ export class ZonedAPI extends ParentAPI { enrichForPagination('frontends', this.pageOfListFrontends, request) /** - * Create a frontend in a given Load Balancer. Create a new frontend for a - * given Load Balancer, specifying its configuration including the port it - * should listen on and the backend to attach it to. + * Create a frontend in a given Load Balancer. Create a new frontend for a given Load Balancer, specifying its configuration including the port it should listen on and the backend to attach it to. * * @param request - The request {@link ZonedApiCreateFrontendRequest} * @returns A Promise of Frontend @@ -756,10 +704,7 @@ export class ZonedAPI extends ParentAPI { ) /** - * Get a frontend. Get the full details of a given frontend, specified by its - * frontend ID. The response contains the frontend's full configuration - * parameters including the backend it is attached to, the port it listens on, - * and any certificates it has. + * Get a frontend. Get the full details of a given frontend, specified by its frontend ID. The response contains the frontend's full configuration parameters including the backend it is attached to, the port it listens on, and any certificates it has. * * @param request - The request {@link ZonedApiGetFrontendRequest} * @returns A Promise of Frontend @@ -774,10 +719,7 @@ export class ZonedAPI extends ParentAPI { ) /** - * Update a frontend. Update a given frontend, specified by its frontend ID. - * You can update configuration parameters including its name and the port it - * listens on. Note that the request type is PUT and not PATCH. You must set - * all parameters. + * Update a frontend. Update a given frontend, specified by its frontend ID. You can update configuration parameters including its name and the port it listens on. Note that the request type is PUT and not PATCH. You must set all parameters. * * @param request - The request {@link ZonedApiUpdateFrontendRequest} * @returns A Promise of Frontend @@ -796,8 +738,7 @@ export class ZonedAPI extends ParentAPI { ) /** - * Delete a frontend. Delete a given frontend, specified by its frontend ID. - * This action is irreversible and cannot be undone. + * Delete a frontend. Delete a given frontend, specified by its frontend ID. This action is irreversible and cannot be undone. * * @param request - The request {@link ZonedApiDeleteFrontendRequest} */ @@ -828,10 +769,7 @@ export class ZonedAPI extends ParentAPI { ) /** - * List all routes. List all routes for a given frontend. The response is an - * array of routes, each one with a specified backend to direct to if a - * certain condition is matched (based on the value of the SNI field or HTTP - * Host header). + * List all routes. List all routes for a given frontend. The response is an array of routes, each one with a specified backend to direct to if a certain condition is matched (based on the value of the SNI field or HTTP Host header). * * @param request - The request {@link ZonedApiListRoutesRequest} * @returns A Promise of ListRoutesResponse @@ -840,9 +778,7 @@ export class ZonedAPI extends ParentAPI { enrichForPagination('routes', this.pageOfListRoutes, request) /** - * Create a route. Create a new route on a given frontend. To configure a - * route, specify the backend to direct to if a certain condition is matched - * (based on the value of the SNI field or HTTP Host header). + * Create a route. Create a new route on a given frontend. To configure a route, specify the backend to direct to if a certain condition is matched (based on the value of the SNI field or HTTP Host header). * * @param request - The request {@link ZonedApiCreateRouteRequest} * @returns A Promise of Route @@ -861,9 +797,7 @@ export class ZonedAPI extends ParentAPI { ) /** - * Get a route. Retrieve information about an existing route, specified by its - * route ID. Its full details, origin frontend, target backend and match - * condition, are returned in the response object. + * Get a route. Retrieve information about an existing route, specified by its route ID. Its full details, origin frontend, target backend and match condition, are returned in the response object. * * @param request - The request {@link ZonedApiGetRouteRequest} * @returns A Promise of Route @@ -878,8 +812,7 @@ export class ZonedAPI extends ParentAPI { ) /** - * Update a route. Update the configuration of an existing route, specified by - * its route ID. + * Update a route. Update the configuration of an existing route, specified by its route ID. * * @param request - The request {@link ZonedApiUpdateRouteRequest} * @returns A Promise of Route @@ -898,8 +831,7 @@ export class ZonedAPI extends ParentAPI { ) /** - * Delete a route. Delete an existing route, specified by its route ID. - * Deleting a route is permanent, and cannot be undone. + * Delete a route. Delete an existing route, specified by its route ID. Deleting a route is permanent, and cannot be undone. * * @param request - The request {@link ZonedApiDeleteRouteRequest} */ @@ -946,8 +878,7 @@ export class ZonedAPI extends ParentAPI { ) /** - * List backend server statistics. List information about your backend - * servers, including their state and the result of their last health check. + * List backend server statistics. List information about your backend servers, including their state and the result of their last health check. * * @param request - The request {@link ZonedApiListBackendStatsRequest} * @returns A Promise of ListBackendStatsResponse @@ -978,10 +909,7 @@ export class ZonedAPI extends ParentAPI { ) /** - * List ACLs for a given frontend. List the ACLs for a given frontend, - * specified by its frontend ID. The response is an array of ACL objects, each - * one representing an ACL that denies or allows traffic based on certain - * conditions. + * List ACLs for a given frontend. List the ACLs for a given frontend, specified by its frontend ID. The response is an array of ACL objects, each one representing an ACL that denies or allows traffic based on certain conditions. * * @param request - The request {@link ZonedApiListAclsRequest} * @returns A Promise of ListAclResponse @@ -990,10 +918,7 @@ export class ZonedAPI extends ParentAPI { enrichForPagination('acls', this.pageOfListAcls, request) /** - * Create an ACL for a given frontend. Create a new ACL for a given frontend. - * Each ACL must have a name, an action to perform (allow or deny), and a - * match rule (the action is carried out when the incoming traffic matches the - * rule). + * Create an ACL for a given frontend. Create a new ACL for a given frontend. Each ACL must have a name, an action to perform (allow or deny), and a match rule (the action is carried out when the incoming traffic matches the rule). * * @param request - The request {@link ZonedApiCreateAclRequest} * @returns A Promise of Acl @@ -1012,9 +937,7 @@ export class ZonedAPI extends ParentAPI { ) /** - * Get an ACL. Get information for a particular ACL, specified by its ACL ID. - * The response returns full details of the ACL, including its name, action, - * match rule and frontend. + * Get an ACL. Get information for a particular ACL, specified by its ACL ID. The response returns full details of the ACL, including its name, action, match rule and frontend. * * @param request - The request {@link ZonedApiGetAclRequest} * @returns A Promise of Acl @@ -1029,8 +952,7 @@ export class ZonedAPI extends ParentAPI { ) /** - * Update an ACL. Update a particular ACL, specified by its ACL ID. You can - * update details including its name, action and match rule. + * Update an ACL. Update a particular ACL, specified by its ACL ID. You can update details including its name, action and match rule. * * @param request - The request {@link ZonedApiUpdateAclRequest} * @returns A Promise of Acl @@ -1049,8 +971,7 @@ export class ZonedAPI extends ParentAPI { ) /** - * Delete an ACL. Delete an ACL, specified by its ACL ID. Deleting an ACL is - * irreversible and cannot be undone. + * Delete an ACL. Delete an ACL, specified by its ACL ID. Deleting an ACL is irreversible and cannot be undone. * * @param request - The request {@link ZonedApiDeleteAclRequest} */ @@ -1061,9 +982,7 @@ export class ZonedAPI extends ParentAPI { }) /** - * Define all ACLs for a given frontend. For a given frontend specified by its - * frontend ID, define and add the complete set of ACLS for that frontend. Any - * existing ACLs on this frontend will be removed. + * Define all ACLs for a given frontend. For a given frontend specified by its frontend ID, define and add the complete set of ACLS for that frontend. Any existing ACLs on this frontend will be removed. * * @param request - The request {@link ZonedApiSetAclsRequest} * @returns A Promise of SetAclsResponse @@ -1082,9 +1001,7 @@ export class ZonedAPI extends ParentAPI { ) /** - * Create an SSL/TLS certificate. Generate a new SSL/TLS certificate for a - * given Load Balancer. You can choose to create a Let's Encrypt certificate, - * or import a custom certificate. + * Create an SSL/TLS certificate. Generate a new SSL/TLS certificate for a given Load Balancer. You can choose to create a Let's Encrypt certificate, or import a custom certificate. * * @param request - The request {@link ZonedApiCreateCertificateRequest} * @returns A Promise of Certificate @@ -1126,10 +1043,7 @@ export class ZonedAPI extends ParentAPI { ) /** - * List all SSL/TLS certificates on a given Load Balancer. List all the - * SSL/TLS certificates on a given Load Balancer. The response is an array of - * certificate objects, which are by default listed in ascending order of - * creation date. + * List all SSL/TLS certificates on a given Load Balancer. List all the SSL/TLS certificates on a given Load Balancer. The response is an array of certificate objects, which are by default listed in ascending order of creation date. * * @param request - The request {@link ZonedApiListCertificatesRequest} * @returns A Promise of ListCertificatesResponse @@ -1138,10 +1052,7 @@ export class ZonedAPI extends ParentAPI { enrichForPagination('certificates', this.pageOfListCertificates, request) /** - * Get an SSL/TLS certificate. Get information for a particular SSL/TLS - * certificate, specified by its certificate ID. The response returns full - * details of the certificate, including its type, main domain name, and - * alternative domain names. + * Get an SSL/TLS certificate. Get information for a particular SSL/TLS certificate, specified by its certificate ID. The response returns full details of the certificate, including its type, main domain name, and alternative domain names. * * @param request - The request {@link ZonedApiGetCertificateRequest} * @returns A Promise of Certificate @@ -1178,8 +1089,7 @@ export class ZonedAPI extends ParentAPI { ) /** - * Update an SSL/TLS certificate. Update the name of a particular SSL/TLS - * certificate, specified by its certificate ID. + * Update an SSL/TLS certificate. Update the name of a particular SSL/TLS certificate, specified by its certificate ID. * * @param request - The request {@link ZonedApiUpdateCertificateRequest} * @returns A Promise of Certificate @@ -1201,9 +1111,7 @@ export class ZonedAPI extends ParentAPI { ) /** - * Delete an SSL/TLS certificate. Delete an SSL/TLS certificate, specified by - * its certificate ID. Deleting a certificate is irreversible and cannot be - * undone. + * Delete an SSL/TLS certificate. Delete an SSL/TLS certificate, specified by its certificate ID. Deleting a certificate is irreversible and cannot be undone. * * @param request - The request {@link ZonedApiDeleteCertificateRequest} */ @@ -1232,9 +1140,7 @@ export class ZonedAPI extends ParentAPI { ) /** - * List all Load Balancer offer types. List all the different commercial Load - * Balancer types. The response includes an array of offer types, each with a - * name, description, and information about its stock availability. + * List all Load Balancer offer types. List all the different commercial Load Balancer types. The response includes an array of offer types, each with a name, description, and information about its stock availability. * * @param request - The request {@link ZonedApiListLbTypesRequest} * @returns A Promise of ListLbTypesResponse @@ -1243,9 +1149,7 @@ export class ZonedAPI extends ParentAPI { enrichForPagination('lbTypes', this.pageOfListLbTypes, request) /** - * Create a subscriber. Create a new subscriber, either with an email - * configuration or a webhook configuration, for a specified Scaleway - * Project. + * Create a subscriber. Create a new subscriber, either with an email configuration or a webhook configuration, for a specified Scaleway Project. * * @param request - The request {@link ZonedApiCreateSubscriberRequest} * @returns A Promise of Subscriber @@ -1264,9 +1168,7 @@ export class ZonedAPI extends ParentAPI { ) /** - * Get a subscriber. Retrieve information about an existing subscriber, - * specified by its subscriber ID. Its full details, including name and - * email/webhook configuration, are returned in the response object. + * Get a subscriber. Retrieve information about an existing subscriber, specified by its subscriber ID. Its full details, including name and email/webhook configuration, are returned in the response object. * * @param request - The request {@link ZonedApiGetSubscriberRequest} * @returns A Promise of Subscriber @@ -1303,10 +1205,7 @@ export class ZonedAPI extends ParentAPI { ) /** - * List all subscribers. List all subscribers to Load Balancer alerts. By - * default, returns all subscribers to Load Balancer alerts for the - * Organization associated with the authentication token used for the - * request. + * List all subscribers. List all subscribers to Load Balancer alerts. By default, returns all subscribers to Load Balancer alerts for the Organization associated with the authentication token used for the request. * * @param request - The request {@link ZonedApiListSubscriberRequest} * @returns A Promise of ListSubscriberResponse @@ -1315,9 +1214,7 @@ export class ZonedAPI extends ParentAPI { enrichForPagination('subscribers', this.pageOfListSubscriber, request) /** - * Update a subscriber. Update the parameters of a given subscriber (e.g. - * name, webhook configuration, email configuration), specified by its - * subscriber ID. + * Update a subscriber. Update the parameters of a given subscriber (e.g. name, webhook configuration, email configuration), specified by its subscriber ID. * * @param request - The request {@link ZonedApiUpdateSubscriberRequest} * @returns A Promise of Subscriber @@ -1336,8 +1233,7 @@ export class ZonedAPI extends ParentAPI { ) /** - * Delete a subscriber. Delete an existing subscriber, specified by its - * subscriber ID. Deleting a subscriber is permanent, and cannot be undone. + * Delete a subscriber. Delete an existing subscriber, specified by its subscriber ID. Deleting a subscriber is permanent, and cannot be undone. * * @param request - The request {@link ZonedApiDeleteSubscriberRequest} */ @@ -1348,8 +1244,7 @@ export class ZonedAPI extends ParentAPI { }) /** - * Subscribe a subscriber to alerts for a given Load Balancer. Subscribe an - * existing subscriber to alerts for a given Load Balancer. + * Subscribe a subscriber to alerts for a given Load Balancer. Subscribe an existing subscriber to alerts for a given Load Balancer. * * @param request - The request {@link ZonedApiSubscribeToLbRequest} * @returns A Promise of Lb @@ -1368,9 +1263,7 @@ export class ZonedAPI extends ParentAPI { ) /** - * Unsubscribe a subscriber from alerts for a given Load Balancer. Unsubscribe - * a subscriber from alerts for a given Load Balancer. The subscriber is not - * deleted, and can be resubscribed in the future if necessary. + * Unsubscribe a subscriber from alerts for a given Load Balancer. Unsubscribe a subscriber from alerts for a given Load Balancer. The subscriber is not deleted, and can be resubscribed in the future if necessary. * * @param request - The request {@link ZonedApiUnsubscribeFromLbRequest} * @returns A Promise of Lb @@ -1404,11 +1297,7 @@ export class ZonedAPI extends ParentAPI { ) /** - * List Private Networks attached to a Load Balancer. List the Private - * Networks attached to a given Load Balancer, specified by its Load Balancer - * ID. The response is an array of Private Network objects, giving information - * including the status, configuration, name and creation date of each Private - * Network. + * List Private Networks attached to a Load Balancer. List the Private Networks attached to a given Load Balancer, specified by its Load Balancer ID. The response is an array of Private Network objects, giving information including the status, configuration, name and creation date of each Private Network. * * @param request - The request {@link ZonedApiListLbPrivateNetworksRequest} * @returns A Promise of ListLbPrivateNetworksResponse @@ -1423,9 +1312,7 @@ export class ZonedAPI extends ParentAPI { ) /** - * Attach a Load Balancer to a Private Network. Attach a specified Load - * Balancer to a specified Private Network, defining a static or DHCP - * configuration for the Load Balancer on the network. + * Attach a Load Balancer to a Private Network. Attach a specified Load Balancer to a specified Private Network, defining a static or DHCP configuration for the Load Balancer on the network. * * @param request - The request {@link ZonedApiAttachPrivateNetworkRequest} * @returns A Promise of PrivateNetwork @@ -1443,14 +1330,13 @@ export class ZonedAPI extends ParentAPI { ), headers: jsonContentHeaders, method: 'POST', - path: `/lb/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/lbs/${validatePathParam('lbId', request.lbId)}/private-networks/${validatePathParam('privateNetworkId', request.privateNetworkId)}/attach`, + path: `/lb/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/lbs/${validatePathParam('lbId', request.lbId)}/attach-private-network`, }, unmarshalPrivateNetwork, ) /** - * Detach Load Balancer from Private Network. Detach a specified Load Balancer - * from a specified Private Network. + * Detach Load Balancer from Private Network. Detach a specified Load Balancer from a specified Private Network. * * @param request - The request {@link ZonedApiDetachPrivateNetworkRequest} */ @@ -1458,17 +1344,22 @@ export class ZonedAPI extends ParentAPI { request: Readonly, ) => this.client.fetch({ - body: '{}', + body: JSON.stringify( + marshalZonedApiDetachPrivateNetworkRequest( + request, + this.client.settings, + ), + ), headers: jsonContentHeaders, method: 'POST', - path: `/lb/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/lbs/${validatePathParam('lbId', request.lbId)}/private-networks/${validatePathParam('privateNetworkId', request.privateNetworkId)}/detach`, + path: `/lb/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/lbs/${validatePathParam('lbId', request.lbId)}/detach-private-network`, }) } /** * Load balancer API. - * - * This API allows you to manage your Load Balancers. + +This API allows you to manage your Load Balancers. */ export class API extends ParentAPI { /** Lists the available regions of the API. */ @@ -2196,8 +2087,7 @@ export class API extends ParentAPI { }) /** - * Create a TLS certificate. Generate a new TLS certificate using Let's - * Encrypt or import your certificate. + * Create a TLS certificate. Generate a new TLS certificate using Let's Encrypt or import your certificate. * * @param request - The request {@link CreateCertificateRequest} * @returns A Promise of Certificate diff --git a/packages/clients/src/api/lb/v1/index.gen.ts b/packages/clients/src/api/lb/v1/index.gen.ts index 4943a11e2..66e090491 100644 --- a/packages/clients/src/api/lb/v1/index.gen.ts +++ b/packages/clients/src/api/lb/v1/index.gen.ts @@ -1,6 +1,9 @@ // This file was automatically generated. DO NOT EDIT. // If you have any remark or suggestion do not hesitate to open an issue. -export { API, ZonedAPI } from './api.gen' +export { + API, + ZonedAPI, +} from './api.gen' export * from './content.gen' export type { Acl, diff --git a/packages/clients/src/api/lb/v1/marshalling.gen.ts b/packages/clients/src/api/lb/v1/marshalling.gen.ts index 1063f3ee1..8ad8d40a1 100644 --- a/packages/clients/src/api/lb/v1/marshalling.gen.ts +++ b/packages/clients/src/api/lb/v1/marshalling.gen.ts @@ -87,6 +87,7 @@ import type { ZonedApiCreateLbRequest, ZonedApiCreateRouteRequest, ZonedApiCreateSubscriberRequest, + ZonedApiDetachPrivateNetworkRequest, ZonedApiMigrateLbRequest, ZonedApiRemoveBackendServersRequest, ZonedApiSetAclsRequest, @@ -1471,6 +1472,7 @@ export const marshalZonedApiAttachPrivateNetworkRequest = ( defaults: DefaultValues, ): Record => ({ ipam_ids: request.ipamIds, + private_network_id: request.privateNetworkId, ...resolveOneOf([ { param: 'static_config', @@ -1675,6 +1677,13 @@ export const marshalZonedApiCreateSubscriberRequest = ( ]), }) +export const marshalZonedApiDetachPrivateNetworkRequest = ( + request: ZonedApiDetachPrivateNetworkRequest, + defaults: DefaultValues, +): Record => ({ + private_network_id: request.privateNetworkId, +}) + export const marshalZonedApiMigrateLbRequest = ( request: ZonedApiMigrateLbRequest, defaults: DefaultValues, diff --git a/packages/clients/src/api/lb/v1/types.gen.ts b/packages/clients/src/api/lb/v1/types.gen.ts index 2d87237dc..d760b0057 100644 --- a/packages/clients/src/api/lb/v1/types.gen.ts +++ b/packages/clients/src/api/lb/v1/types.gen.ts @@ -125,51 +125,60 @@ export type SSLCompatibilityLevel = export type StickySessionsType = 'none' | 'cookie' | 'table' export interface SubscriberEmailConfig { - /** Email address to send alerts to. */ + /** + * Email address to send alerts to. + */ email: string } -/** Webhook alert of subscriber. */ +/** + * Webhook alert of subscriber. + */ export interface SubscriberWebhookConfig { - /** URI to receive POST requests. */ + /** + * URI to receive POST requests. + */ uri: string } export interface HealthCheckHttpConfig { - /** The HTTP path to use when performing a health check on backend servers. */ + /** + * The HTTP path to use when performing a health check on backend servers. + */ uri: string - /** The HTTP method used when performing a health check on backend servers. */ + /** + * The HTTP method used when performing a health check on backend servers. + */ method: string /** - * The HTTP response code that should be returned for a health check to be - * considered successful. + * The HTTP response code that should be returned for a health check to be considered successful. */ code?: number /** - * The HTTP host header used when performing a health check on backend - * servers. + * The HTTP host header used when performing a health check on backend servers. */ hostHeader: string } export interface HealthCheckHttpsConfig { - /** The HTTP path to use when performing a health check on backend servers. */ + /** + * The HTTP path to use when performing a health check on backend servers. + */ uri: string - /** The HTTP method used when performing a health check on backend servers. */ + /** + * The HTTP method used when performing a health check on backend servers. + */ method: string /** - * The HTTP response code that should be returned for a health check to be - * considered successful. + * The HTTP response code that should be returned for a health check to be considered successful. */ code?: number /** - * The HTTP host header used when performing a health check on backend - * servers. + * The HTTP host header used when performing a health check on backend servers. */ hostHeader: string /** - * The SNI value used when performing a health check on backend servers over - * SSL. + * The SNI value used when performing a health check on backend servers over SSL. */ sni: string } @@ -177,12 +186,16 @@ export interface HealthCheckHttpsConfig { export interface HealthCheckLdapConfig {} export interface HealthCheckMysqlConfig { - /** MySQL user to use for the health check. */ + /** + * MySQL user to use for the health check. + */ user: string } export interface HealthCheckPgsqlConfig { - /** PostgreSQL user to use for the health check. */ + /** + * PostgreSQL user to use for the health check. + */ user: string } @@ -191,387 +204,515 @@ export interface HealthCheckRedisConfig {} export interface HealthCheckTcpConfig {} export interface Instance { - /** Underlying Instance ID. */ + /** + * Underlying Instance ID. + */ id: string - /** Instance status. */ + /** + * Instance status. + */ status: InstanceStatus - /** Instance IP address. */ + /** + * Instance IP address. + */ ipAddress: string - /** Date on which the Instance was created. */ + /** + * Date on which the Instance was created. + */ createdAt?: Date - /** Date on which the Instance was last updated. */ + /** + * Date on which the Instance was last updated. + */ updatedAt?: Date - /** @deprecated The region the Instance is in. */ + /** + * @deprecated The region the Instance is in. + */ region?: ScwRegion - /** The zone the Instance is in. */ + /** + * The zone the Instance is in. + */ zone: ScwZone } export interface Ip { - /** IP address ID. */ + /** + * IP address ID. + */ id: string - /** IP address. */ + /** + * IP address. + */ ipAddress: string - /** Organization ID of the Scaleway Organization the IP address is in. */ + /** + * Organization ID of the Scaleway Organization the IP address is in. + */ organizationId: string - /** Project ID of the Scaleway Project the IP address is in. */ + /** + * Project ID of the Scaleway Project the IP address is in. + */ projectId: string - /** Load Balancer ID. */ + /** + * Load Balancer ID. + */ lbId?: string - /** Reverse DNS (domain name) of the IP address. */ + /** + * Reverse DNS (domain name) of the IP address. + */ reverse: string - /** IP tags. */ + /** + * IP tags. + */ tags: string[] - /** @deprecated The region the IP address is in. */ + /** + * @deprecated The region the IP address is in. + */ region?: ScwRegion - /** The zone the IP address is in. */ + /** + * The zone the IP address is in. + */ zone: ScwZone } -/** Subscriber. */ +/** + * Subscriber. + */ export interface Subscriber { - /** Subscriber ID. */ + /** + * Subscriber ID. + */ id: string - /** Subscriber name. */ + /** + * Subscriber name. + */ name: string /** * Email address of subscriber. * - * One-of ('config'): at most one of 'emailConfig', 'webhookConfig' could be - * set. + * One-of ('config'): at most one of 'emailConfig', 'webhookConfig' could be set. */ emailConfig?: SubscriberEmailConfig /** * Webhook URI of subscriber. * - * One-of ('config'): at most one of 'emailConfig', 'webhookConfig' could be - * set. + * One-of ('config'): at most one of 'emailConfig', 'webhookConfig' could be set. */ webhookConfig?: SubscriberWebhookConfig } export interface HealthCheck { - /** Port to use for the backend server health check. */ + /** + * Port to use for the backend server health check. + */ port: number - /** Time to wait between two consecutive health checks. */ + /** + * Time to wait between two consecutive health checks. + */ checkDelay?: string - /** Maximum time a backend server has to reply to the health check. */ + /** + * Maximum time a backend server has to reply to the health check. + */ checkTimeout?: string /** - * Number of consecutive unsuccessful health checks after which the server - * will be considered dead. + * Number of consecutive unsuccessful health checks after which the server will be considered dead. */ checkMaxRetries: number /** * Object to configure a basic TCP health check. * - * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', - * 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' - * could be set. + * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' could be set. */ tcpConfig?: HealthCheckTcpConfig /** - * Object to configure a MySQL health check. The check requires MySQL >=3.22 - * or <9.0. For older or newer versions, use a TCP health check. + * Object to configure a MySQL health check. The check requires MySQL >=3.22 or <9.0. For older or newer versions, use a TCP health check. * - * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', - * 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' - * could be set. + * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' could be set. */ mysqlConfig?: HealthCheckMysqlConfig /** * Object to configure a PostgreSQL health check. * - * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', - * 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' - * could be set. + * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' could be set. */ pgsqlConfig?: HealthCheckPgsqlConfig /** - * Object to configure an LDAP health check. The response is analyzed to find - * the LDAPv3 response message. + * Object to configure an LDAP health check. The response is analyzed to find the LDAPv3 response message. * - * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', - * 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' - * could be set. + * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' could be set. */ ldapConfig?: HealthCheckLdapConfig /** - * Object to configure a Redis health check. The response is analyzed to find - * the +PONG response message. + * Object to configure a Redis health check. The response is analyzed to find the +PONG response message. * - * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', - * 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' - * could be set. + * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' could be set. */ redisConfig?: HealthCheckRedisConfig /** * Object to configure an HTTP health check. * - * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', - * 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' - * could be set. + * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' could be set. */ httpConfig?: HealthCheckHttpConfig /** * Object to configure an HTTPS health check. * - * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', - * 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' - * could be set. + * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' could be set. */ httpsConfig?: HealthCheckHttpsConfig - /** Defines whether proxy protocol should be activated for the health check. */ + /** + * Defines whether proxy protocol should be activated for the health check. + */ checkSendProxy: boolean /** - * Time to wait between two consecutive health checks when a backend server is - * in a transient state (going UP or DOWN). + * Time to wait between two consecutive health checks when a backend server is in a transient state (going UP or DOWN). */ transientCheckDelay?: string } export interface Lb { - /** Underlying Instance ID. */ + /** + * Underlying Instance ID. + */ id: string - /** Load Balancer name. */ + /** + * Load Balancer name. + */ name: string - /** Load Balancer description. */ + /** + * Load Balancer description. + */ description: string - /** Load Balancer status. */ + /** + * Load Balancer status. + */ status: LbStatus - /** List of underlying Instances. */ + /** + * List of underlying Instances. + */ instances: Instance[] - /** Scaleway Organization ID. */ + /** + * Scaleway Organization ID. + */ organizationId: string - /** Scaleway Project ID. */ + /** + * Scaleway Project ID. + */ projectId: string - /** List of IP addresses attached to the Load Balancer. */ + /** + * List of IP addresses attached to the Load Balancer. + */ ip: Ip[] - /** Load Balancer tags. */ + /** + * Load Balancer tags. + */ tags: string[] - /** Number of frontends the Load Balancer has. */ + /** + * Number of frontends the Load Balancer has. + */ frontendCount: number - /** Number of backends the Load Balancer has. */ + /** + * Number of backends the Load Balancer has. + */ backendCount: number - /** Load Balancer offer type. */ + /** + * Load Balancer offer type. + */ type: string - /** Subscriber information. */ + /** + * Subscriber information. + */ subscriber?: Subscriber /** - * Determines the minimal SSL version which needs to be supported on client - * side. + * Determines the minimal SSL version which needs to be supported on client side. */ sslCompatibilityLevel: SSLCompatibilityLevel - /** Date on which the Load Balancer was created. */ + /** + * Date on which the Load Balancer was created. + */ createdAt?: Date - /** Date on which the Load Balancer was last updated. */ + /** + * Date on which the Load Balancer was last updated. + */ updatedAt?: Date - /** Number of Private Networks attached to the Load Balancer. */ + /** + * Number of Private Networks attached to the Load Balancer. + */ privateNetworkCount: number - /** Number of routes configured on the Load Balancer. */ + /** + * Number of routes configured on the Load Balancer. + */ routeCount: number - /** @deprecated The region the Load Balancer is in. */ + /** + * @deprecated The region the Load Balancer is in. + */ region?: ScwRegion - /** The zone the Load Balancer is in. */ + /** + * The zone the Load Balancer is in. + */ zone: ScwZone } export interface AclActionRedirect { - /** Redirect type. */ + /** + * Redirect type. + */ type: AclActionRedirectRedirectType /** - * Redirect target. For a location redirect, you can use a URL e.g. - * `https://scaleway.com`. Using a scheme name (e.g. `https`, `http`, `ftp`, - * `git`) will replace the request's original scheme. This can be useful to - * implement HTTP to HTTPS redirects. Valid placeholders that can be used in a - * `location` redirect to preserve parts of the original request in the - * redirection URL are {{host}}, {{query}}, {{path}} and {{scheme}}. + * Redirect target. For a location redirect, you can use a URL e.g. `https://scaleway.com`. Using a scheme name (e.g. `https`, `http`, `ftp`, `git`) will replace the request's original scheme. This can be useful to implement HTTP to HTTPS redirects. Valid placeholders that can be used in a `location` redirect to preserve parts of the original request in the redirection URL are \{\{host\}\}, \{\{query\}\}, \{\{path\}\} and \{\{scheme\}\}. */ target: string /** - * HTTP redirect code to use. Valid values are 301, 302, 303, 307 and 308. - * Default value is 302. + * HTTP redirect code to use. Valid values are 301, 302, 303, 307 and 308. Default value is 302. */ code?: number } export interface Backend { - /** Backend ID. */ + /** + * Backend ID. + */ id: string - /** Name of the backend. */ + /** + * Name of the backend. + */ name: string - /** Protocol used by the backend when forwarding traffic to backend servers. */ + /** + * Protocol used by the backend when forwarding traffic to backend servers. + */ forwardProtocol: Protocol - /** Port used by the backend when forwarding traffic to backend servers. */ + /** + * Port used by the backend when forwarding traffic to backend servers. + */ forwardPort: number /** - * Load balancing algorithm to use when determining which backend server to - * forward new traffic to. + * Load balancing algorithm to use when determining which backend server to forward new traffic to. */ forwardPortAlgorithm: ForwardPortAlgorithm /** - * Defines whether sticky sessions (binding a particular session to a - * particular backend server) are activated and the method to use if so. None - * disables sticky sessions. Cookie-based uses an HTTP cookie to stick a - * session to a backend server. Table-based uses the source (client) IP - * address to stick a session to a backend server. + * Defines whether sticky sessions (binding a particular session to a particular backend server) are activated and the method to use if so. None disables sticky sessions. Cookie-based uses an HTTP cookie to stick a session to a backend server. Table-based uses the source (client) IP address to stick a session to a backend server. */ stickySessions: StickySessionsType - /** Cookie name for cookie-based sticky sessions. */ + /** + * Cookie name for cookie-based sticky sessions. + */ stickySessionsCookieName: string /** - * Object defining the health check to be carried out by the backend when - * checking the status and health of backend servers. + * Object defining the health check to be carried out by the backend when checking the status and health of backend servers. */ healthCheck?: HealthCheck - /** List of IP addresses of backend servers attached to this backend. */ + /** + * List of IP addresses of backend servers attached to this backend. + */ pool: string[] - /** Load Balancer the backend is attached to. */ + /** + * Load Balancer the backend is attached to. + */ lb?: Lb - /** @deprecated Deprecated in favor of proxy_protocol field. */ + /** + * @deprecated Deprecated in favor of proxy_protocol field. + */ sendProxyV2?: boolean - /** Maximum allowed time for a backend server to process a request. */ + /** + * Maximum allowed time for a backend server to process a request. + */ timeoutServer?: string - /** Maximum allowed time for establishing a connection to a backend server. */ + /** + * Maximum allowed time for establishing a connection to a backend server. + */ timeoutConnect?: string /** - * Maximum allowed tunnel inactivity time after Websocket is established - * (takes precedence over client and server timeout). + * Maximum allowed tunnel inactivity time after Websocket is established (takes precedence over client and server timeout). */ timeoutTunnel?: string - /** Action to take when a backend server is marked as down. */ + /** + * Action to take when a backend server is marked as down. + */ onMarkedDownAction: OnMarkedDownAction /** - * Protocol to use between the Load Balancer and backend servers. Allows the - * backend servers to be informed of the client's real IP address. The PROXY - * protocol must be supported by the backend servers' software. + * Protocol to use between the Load Balancer and backend servers. Allows the backend servers to be informed of the client's real IP address. The PROXY protocol must be supported by the backend servers' software. */ proxyProtocol: ProxyProtocol - /** Date at which the backend was created. */ + /** + * Date at which the backend was created. + */ createdAt?: Date - /** Date at which the backend was updated. */ + /** + * Date at which the backend was updated. + */ updatedAt?: Date /** - * Scaleway Object Storage bucket website to be served as failover if all - * backend servers are down, e.g. - * failover-website.s3-website.fr-par.scw.cloud. + * Scaleway Object Storage bucket website to be served as failover if all backend servers are down, e.g. failover-website.s3-website.fr-par.scw.cloud. */ failoverHost?: string /** - * Defines whether to enable SSL bridging between the Load Balancer and - * backend servers. + * Defines whether to enable SSL bridging between the Load Balancer and backend servers. */ sslBridging?: boolean - /** Defines whether the server certificate verification should be ignored. */ + /** + * Defines whether the server certificate verification should be ignored. + */ ignoreSslServerVerify?: boolean - /** Whether to use another backend server on each attempt. */ + /** + * Whether to use another backend server on each attempt. + */ redispatchAttemptCount?: number - /** Number of retries when a backend server connection failed. */ + /** + * Number of retries when a backend server connection failed. + */ maxRetries?: number - /** Maximum number of connections allowed per backend server. */ + /** + * Maximum number of connections allowed per backend server. + */ maxConnections?: number /** - * Maximum time for a request to be left pending in queue when - * `max_connections` is reached. + * Maximum time for a request to be left pending in queue when `max_connections` is reached. */ timeoutQueue?: string } export interface Certificate { - /** Certificate type (Let's Encrypt or custom). */ + /** + * Certificate type (Let's Encrypt or custom). + */ type: CertificateType - /** Certificate ID. */ + /** + * Certificate ID. + */ id: string - /** Main domain name of certificate. */ + /** + * Main domain name of certificate. + */ commonName: string - /** Alternative domain names. */ + /** + * Alternative domain names. + */ subjectAlternativeName: string[] - /** Identifier (SHA-1) of the certificate. */ + /** + * Identifier (SHA-1) of the certificate. + */ fingerprint: string - /** Lower validity bound. */ + /** + * Lower validity bound. + */ notValidBefore?: Date - /** Upper validity bound. */ + /** + * Upper validity bound. + */ notValidAfter?: Date - /** Certificate status. */ + /** + * Certificate status. + */ status: CertificateStatus - /** Load Balancer object the certificate is attached to. */ + /** + * Load Balancer object the certificate is attached to. + */ lb?: Lb - /** Certificate name. */ + /** + * Certificate name. + */ name: string - /** Date on which the certificate was created. */ + /** + * Date on which the certificate was created. + */ createdAt?: Date - /** Date on which the certificate was last updated. */ + /** + * Date on which the certificate was last updated. + */ updatedAt?: Date /** - * Additional information about the certificate status (useful in case of - * certificate generation failure, for example). + * Additional information about the certificate status (useful in case of certificate generation failure, for example). */ statusDetails?: string } export interface AclAction { - /** Action to take when incoming traffic matches an ACL filter. */ + /** + * Action to take when incoming traffic matches an ACL filter. + */ type: AclActionType - /** Redirection parameters when using an ACL with a `redirect` action. */ + /** + * Redirection parameters when using an ACL with a `redirect` action. + */ redirect?: AclActionRedirect } export interface AclMatch { - /** List of IPs or CIDR v4/v6 addresses to filter for from the client side. */ + /** + * List of IPs or CIDR v4/v6 addresses to filter for from the client side. + */ ipSubnet: string[] /** - * Type of HTTP filter to match. Extracts the request's URL path, which starts - * at the first slash and ends before the question mark (without the host - * part). Defines where to filter for the http_filter_value. Only supported - * for HTTP backends. + * Type of HTTP filter to match. Extracts the request's URL path, which starts at the first slash and ends before the question mark (without the host part). Defines where to filter for the http_filter_value. Only supported for HTTP backends. */ httpFilter: AclHttpFilter - /** List of values to filter for. */ + /** + * List of values to filter for. + */ httpFilterValue: string[] /** - * Name of the HTTP header to filter on if `http_header_match` was selected in - * `http_filter`. + * Name of the HTTP header to filter on if `http_header_match` was selected in `http_filter`. */ httpFilterOption?: string /** - * Defines whether to invert the match condition. If set to `true`, the ACL - * carries out its action when the condition DOES NOT match. + * Defines whether to invert the match condition. If set to `true`, the ACL carries out its action when the condition DOES NOT match. */ invert: boolean } export interface Frontend { - /** Frontend ID. */ + /** + * Frontend ID. + */ id: string - /** Name of the frontend. */ + /** + * Name of the frontend. + */ name: string - /** Port the frontend listens on. */ + /** + * Port the frontend listens on. + */ inboundPort: number - /** Backend object the frontend is attached to. */ + /** + * Backend object the frontend is attached to. + */ backend?: Backend - /** Load Balancer object the frontend is attached to. */ + /** + * Load Balancer object the frontend is attached to. + */ lb?: Lb - /** Maximum allowed inactivity time on the client side. */ + /** + * Maximum allowed inactivity time on the client side. + */ timeoutClient?: string - /** @deprecated Certificate, deprecated in favor of certificate_ids array. */ + /** + * @deprecated Certificate, deprecated in favor of certificate_ids array. + */ certificate?: Certificate - /** List of SSL/TLS certificate IDs to bind to the frontend. */ + /** + * List of SSL/TLS certificate IDs to bind to the frontend. + */ certificateIds: string[] - /** Date on which the frontend was created. */ + /** + * Date on which the frontend was created. + */ createdAt?: Date - /** Date on which the frontend was last updated. */ + /** + * Date on which the frontend was last updated. + */ updatedAt?: Date - /** Defines whether to enable HTTP/3 protocol on the frontend. */ + /** + * Defines whether to enable HTTP/3 protocol on the frontend. + */ enableHttp3: boolean /** - * Rate limit for new connections established on this frontend. Use 0 value to - * disable, else value is connections per second. + * Rate limit for new connections established on this frontend. Use 0 value to disable, else value is connections per second. */ connectionRateLimit?: number } export interface PrivateNetworkDHCPConfig { - /** @deprecated */ + /** + * @deprecated + */ ipId?: string } @@ -579,2445 +720,3022 @@ export interface PrivateNetworkIpamConfig {} export interface PrivateNetworkStaticConfig { /** - * @deprecated Array of a local IP address for the Load Balancer on this - * Private Network. + * @deprecated Array of a local IP address for the Load Balancer on this Private Network. */ ipAddress?: string[] } export interface RouteMatch { /** - * Value to match in the Server Name Indication TLS extension (SNI) field from - * an incoming connection made via an SSL/TLS transport layer. This field - * should be set for routes on TCP Load Balancers. + * Value to match in the Server Name Indication TLS extension (SNI) field from an incoming connection made via an SSL/TLS transport layer. This field should be set for routes on TCP Load Balancers. * * One-of ('matchType'): at most one of 'sni', 'hostHeader' could be set. */ sni?: string /** - * Value to match in the HTTP Host request header from an incoming request. - * This field should be set for routes on HTTP Load Balancers. + * Value to match in the HTTP Host request header from an incoming request. This field should be set for routes on HTTP Load Balancers. * * One-of ('matchType'): at most one of 'sni', 'hostHeader' could be set. */ hostHeader?: string - /** If true, all subdomains will match. */ + /** + * If true, all subdomains will match. + */ matchSubdomains: boolean } export interface CreateCertificateRequestCustomCertificate { /** - * Full PEM-formatted certificate, consisting of the entire certificate chain - * including public key, private key, and (optionally) Certificate - * Authorities. + * Full PEM-formatted certificate, consisting of the entire certificate chain including public key, private key, and (optionally) Certificate Authorities. */ certificateChain: string } export interface CreateCertificateRequestLetsencryptConfig { /** - * Main domain name of certificate (this domain must exist and resolve to your - * Load Balancer IP address). + * Main domain name of certificate (this domain must exist and resolve to your Load Balancer IP address). */ commonName: string /** - * Alternative domain names (all domain names must exist and resolve to your - * Load Balancer IP address). + * Alternative domain names (all domain names must exist and resolve to your Load Balancer IP address). */ subjectAlternativeName: string[] } export interface BackendServerStats { - /** ID of your Load Balancer's underlying Instance. */ + /** + * ID of your Load Balancer's underlying Instance. + */ instanceId: string - /** Backend ID. */ + /** + * Backend ID. + */ backendId: string - /** IPv4 or IPv6 address of the backend server. */ + /** + * IPv4 or IPv6 address of the backend server. + */ ip: string - /** Server operational state (stopped/starting/running/stopping). */ + /** + * Server operational state (stopped/starting/running/stopping). + */ serverState: BackendServerStatsServerState - /** Time since last operational change. */ + /** + * Time since last operational change. + */ serverStateChangedAt?: Date - /** Last health check status (unknown/neutral/failed/passed/condpass). */ + /** + * Last health check status (unknown/neutral/failed/passed/condpass). + */ lastHealthCheckStatus: BackendServerStatsHealthCheckStatus } export interface Acl { - /** ACL ID. */ + /** + * ACL ID. + */ id: string - /** ACL name. */ + /** + * ACL name. + */ name: string /** - * ACL match filter object. One of `ip_subnet` or `http_filter` & - * `http_filter_value` are required. + * ACL match filter object. One of `ip_subnet` or `http_filter` & `http_filter_value` are required. */ match?: AclMatch - /** Action to take when incoming traffic matches an ACL filter. */ + /** + * Action to take when incoming traffic matches an ACL filter. + */ action?: AclAction - /** ACL is attached to this frontend object. */ + /** + * ACL is attached to this frontend object. + */ frontend?: Frontend /** - * Priority of this ACL (ACLs are applied in ascending order, 0 is the first - * ACL executed). + * Priority of this ACL (ACLs are applied in ascending order, 0 is the first ACL executed). */ index: number - /** Date on which the ACL was created. */ + /** + * Date on which the ACL was created. + */ createdAt?: Date - /** Date on which the ACL was last updated. */ + /** + * Date on which the ACL was last updated. + */ updatedAt?: Date - /** ACL description. */ + /** + * ACL description. + */ description: string } export interface PrivateNetwork { - /** Load Balancer object which is attached to the Private Network. */ + /** + * Load Balancer object which is attached to the Private Network. + */ lb?: Lb - /** IPAM IDs of the booked IP addresses. */ + /** + * IPAM IDs of the booked IP addresses. + */ ipamIds: string[] /** - * @deprecated Object containing an array of a local IP address for the Load - * Balancer on this Private Network. + * @deprecated Object containing an array of a local IP address for the Load Balancer on this Private Network. * - * One-of ('config'): at most one of 'staticConfig', 'dhcpConfig', - * 'ipamConfig' could be set. + * One-of ('config'): at most one of 'staticConfig', 'dhcpConfig', 'ipamConfig' could be set. */ staticConfig?: PrivateNetworkStaticConfig /** * @deprecated Object containing DHCP-assigned IP addresses. * - * One-of ('config'): at most one of 'staticConfig', 'dhcpConfig', - * 'ipamConfig' could be set. + * One-of ('config'): at most one of 'staticConfig', 'dhcpConfig', 'ipamConfig' could be set. */ dhcpConfig?: PrivateNetworkDHCPConfig /** * @deprecated For internal use only. * - * One-of ('config'): at most one of 'staticConfig', 'dhcpConfig', - * 'ipamConfig' could be set. + * One-of ('config'): at most one of 'staticConfig', 'dhcpConfig', 'ipamConfig' could be set. */ ipamConfig?: PrivateNetworkIpamConfig - /** Private Network ID. */ + /** + * Private Network ID. + */ privateNetworkId: string - /** Status of Private Network connection. */ + /** + * Status of Private Network connection. + */ status: PrivateNetworkStatus - /** Date on which the Private Network was created. */ + /** + * Date on which the Private Network was created. + */ createdAt?: Date - /** Date on which the PN was last updated. */ + /** + * Date on which the PN was last updated. + */ updatedAt?: Date } export interface LbType { - /** Load Balancer commercial offer type name. */ + /** + * Load Balancer commercial offer type name. + */ name: string - /** Current stock status for a given Load Balancer type. */ + /** + * Current stock status for a given Load Balancer type. + */ stockStatus: LbTypeStock - /** Load Balancer commercial offer type description. */ + /** + * Load Balancer commercial offer type description. + */ description: string - /** @deprecated The region the Load Balancer stock is in. */ + /** + * @deprecated The region the Load Balancer stock is in. + */ region?: ScwRegion - /** The zone the Load Balancer stock is in. */ + /** + * The zone the Load Balancer stock is in. + */ zone: ScwZone } export interface Route { - /** Route ID. */ + /** + * Route ID. + */ id: string - /** ID of the source frontend. */ + /** + * ID of the source frontend. + */ frontendId: string - /** ID of the target backend. */ + /** + * ID of the target backend. + */ backendId: string /** - * Object defining the match condition for a route to be applied. If an - * incoming client session matches the specified condition (i.e. it has a - * matching SNI value or HTTP Host header value), it will be passed to the - * target backend. + * Object defining the match condition for a route to be applied. If an incoming client session matches the specified condition (i.e. it has a matching SNI value or HTTP Host header value), it will be passed to the target backend. */ match?: RouteMatch - /** Date on which the route was created. */ + /** + * Date on which the route was created. + */ createdAt?: Date - /** Date on which the route was last updated. */ + /** + * Date on which the route was last updated. + */ updatedAt?: Date } export interface AclSpec { - /** ACL name. */ + /** + * ACL name. + */ name: string - /** Action to take when incoming traffic matches an ACL filter. */ + /** + * Action to take when incoming traffic matches an ACL filter. + */ action: AclAction /** - * ACL match filter object. One of `ip_subnet` or `http_filter` and - * `http_filter_value` are required. + * ACL match filter object. One of `ip_subnet` or `http_filter` and `http_filter_value` are required. */ match?: AclMatch /** - * Priority of this ACL (ACLs are applied in ascending order, 0 is the first - * ACL executed). + * Priority of this ACL (ACLs are applied in ascending order, 0 is the first ACL executed). */ index: number - /** ACL description. */ + /** + * ACL description. + */ description: string } export type AddBackendServersRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Backend ID. */ + /** + * Backend ID. + */ backendId: string - /** List of IP addresses to add to backend servers. */ + /** + * List of IP addresses to add to backend servers. + */ serverIp: string[] } export type AttachPrivateNetworkRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Load Balancer ID. */ + /** + * Load Balancer ID. + */ lbId: string - /** Private Network ID. */ + /** + * Private Network ID. + */ privateNetworkId: string /** - * @deprecated Object containing an array of a local IP address for the Load - * Balancer on this Private Network. + * @deprecated Object containing an array of a local IP address for the Load Balancer on this Private Network. * - * One-of ('config'): at most one of 'staticConfig', 'dhcpConfig', - * 'ipamConfig' could be set. + * One-of ('config'): at most one of 'staticConfig', 'dhcpConfig', 'ipamConfig' could be set. */ staticConfig?: PrivateNetworkStaticConfig /** * @deprecated Defines whether to let DHCP assign IP addresses. * - * One-of ('config'): at most one of 'staticConfig', 'dhcpConfig', - * 'ipamConfig' could be set. + * One-of ('config'): at most one of 'staticConfig', 'dhcpConfig', 'ipamConfig' could be set. */ dhcpConfig?: PrivateNetworkDHCPConfig /** * @deprecated For internal use only. * - * One-of ('config'): at most one of 'staticConfig', 'dhcpConfig', - * 'ipamConfig' could be set. + * One-of ('config'): at most one of 'staticConfig', 'dhcpConfig', 'ipamConfig' could be set. */ ipamConfig?: PrivateNetworkIpamConfig /** - * IPAM ID of a pre-reserved IP address to assign to the Load Balancer on this - * Private Network. In the future, it will be possible to specify multiple IPs - * in this field (IPv4 and IPv6), for now only one ID of an IPv4 address is - * expected. When null, a new private IP address is created for the Load - * Balancer on this Private Network. + * IPAM ID of a pre-reserved IP address to assign to the Load Balancer on this Private Network. In the future, it will be possible to specify multiple IPs in this field (IPv4 and IPv6), for now only one ID of an IPv4 address is expected. When null, a new private IP address is created for the Load Balancer on this Private Network. */ ipamIds?: string[] } -/** Add an ACL to a Load Balancer frontend. */ +/** + * Add an ACL to a Load Balancer frontend. + */ export type CreateAclRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Frontend ID to attach the ACL to. */ + /** + * Frontend ID to attach the ACL to. + */ frontendId: string - /** ACL name. */ + /** + * ACL name. + */ name?: string - /** Action to take when incoming traffic matches an ACL filter. */ + /** + * Action to take when incoming traffic matches an ACL filter. + */ action: AclAction /** - * ACL match filter object. One of `ip_subnet` or `http_filter` & - * `http_filter_value` are required. + * ACL match filter object. One of `ip_subnet` or `http_filter` & `http_filter_value` are required. */ match?: AclMatch /** - * Priority of this ACL (ACLs are applied in ascending order, 0 is the first - * ACL executed). + * Priority of this ACL (ACLs are applied in ascending order, 0 is the first ACL executed). */ index: number - /** ACL description. */ + /** + * ACL description. + */ description: string } export type CreateBackendRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Load Balancer ID. */ + /** + * Load Balancer ID. + */ lbId: string - /** Name for the backend. */ + /** + * Name for the backend. + */ name?: string /** - * Protocol to be used by the backend when forwarding traffic to backend - * servers. + * Protocol to be used by the backend when forwarding traffic to backend servers. */ forwardProtocol: Protocol - /** Port to be used by the backend when forwarding traffic to backend servers. */ + /** + * Port to be used by the backend when forwarding traffic to backend servers. + */ forwardPort: number /** - * Load balancing algorithm to be used when determining which backend server - * to forward new traffic to. + * Load balancing algorithm to be used when determining which backend server to forward new traffic to. */ forwardPortAlgorithm: ForwardPortAlgorithm /** - * Defines whether to activate sticky sessions (binding a particular session - * to a particular backend server) and the method to use if so. None disables - * sticky sessions. Cookie-based uses an HTTP cookie TO stick a session to a - * backend server. Table-based uses the source (client) IP address to stick a - * session to a backend server. + * Defines whether to activate sticky sessions (binding a particular session to a particular backend server) and the method to use if so. None disables sticky sessions. Cookie-based uses an HTTP cookie TO stick a session to a backend server. Table-based uses the source (client) IP address to stick a session to a backend server. */ stickySessions: StickySessionsType - /** Cookie name for cookie-based sticky sessions. */ + /** + * Cookie name for cookie-based sticky sessions. + */ stickySessionsCookieName: string /** - * Object defining the health check to be carried out by the backend when - * checking the status and health of backend servers. + * Object defining the health check to be carried out by the backend when checking the status and health of backend servers. */ healthCheck: HealthCheck /** - * List of backend server IP addresses (IPv4 or IPv6) the backend should - * forward traffic to. + * List of backend server IP addresses (IPv4 or IPv6) the backend should forward traffic to. */ serverIp: string[] - /** @deprecated Deprecated in favor of proxy_protocol field. */ + /** + * @deprecated Deprecated in favor of proxy_protocol field. + */ sendProxyV2?: boolean - /** Maximum allowed time for a backend server to process a request. */ + /** + * Maximum allowed time for a backend server to process a request. + */ timeoutServer?: string - /** Maximum allowed time for establishing a connection to a backend server. */ + /** + * Maximum allowed time for establishing a connection to a backend server. + */ timeoutConnect?: string /** - * Maximum allowed tunnel inactivity time after Websocket is established - * (takes precedence over client and server timeout). + * Maximum allowed tunnel inactivity time after Websocket is established (takes precedence over client and server timeout). */ timeoutTunnel?: string - /** Action to take when a backend server is marked as down. */ + /** + * Action to take when a backend server is marked as down. + */ onMarkedDownAction?: OnMarkedDownAction /** - * Protocol to use between the Load Balancer and backend servers. Allows the - * backend servers to be informed of the client's real IP address. The PROXY - * protocol must be supported by the backend servers' software. + * Protocol to use between the Load Balancer and backend servers. Allows the backend servers to be informed of the client's real IP address. The PROXY protocol must be supported by the backend servers' software. */ proxyProtocol?: ProxyProtocol /** - * Scaleway Object Storage bucket website to be served as failover if all - * backend servers are down, e.g. - * failover-website.s3-website.fr-par.scw.cloud. + * Scaleway Object Storage bucket website to be served as failover if all backend servers are down, e.g. failover-website.s3-website.fr-par.scw.cloud. */ failoverHost?: string /** - * Defines whether to enable SSL bridging between the Load Balancer and - * backend servers. + * Defines whether to enable SSL bridging between the Load Balancer and backend servers. */ sslBridging?: boolean - /** Defines whether the server certificate verification should be ignored. */ + /** + * Defines whether the server certificate verification should be ignored. + */ ignoreSslServerVerify?: boolean - /** Whether to use another backend server on each attempt. */ + /** + * Whether to use another backend server on each attempt. + */ redispatchAttemptCount?: number - /** Number of retries when a backend server connection failed. */ + /** + * Number of retries when a backend server connection failed. + */ maxRetries?: number - /** Maximum number of connections allowed per backend server. */ + /** + * Maximum number of connections allowed per backend server. + */ maxConnections?: number /** - * Maximum time for a request to be left pending in queue when - * `max_connections` is reached. + * Maximum time for a request to be left pending in queue when `max_connections` is reached. */ timeoutQueue?: string } export type CreateCertificateRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Load Balancer ID. */ + /** + * Load Balancer ID. + */ lbId: string - /** Name for the certificate. */ + /** + * Name for the certificate. + */ name?: string /** * Object to define a new Let's Encrypt certificate to be generated. * - * One-of ('type'): at most one of 'letsencrypt', 'customCertificate' could be - * set. + * One-of ('type'): at most one of 'letsencrypt', 'customCertificate' could be set. */ letsencrypt?: CreateCertificateRequestLetsencryptConfig /** * Object to define an existing custom certificate to be imported. * - * One-of ('type'): at most one of 'letsencrypt', 'customCertificate' could be - * set. + * One-of ('type'): at most one of 'letsencrypt', 'customCertificate' could be set. */ customCertificate?: CreateCertificateRequestCustomCertificate } export type CreateFrontendRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Load Balancer ID (ID of the Load Balancer to attach the frontend to). */ + /** + * Load Balancer ID (ID of the Load Balancer to attach the frontend to). + */ lbId: string - /** Name for the frontend. */ + /** + * Name for the frontend. + */ name?: string - /** Port the frontend should listen on. */ + /** + * Port the frontend should listen on. + */ inboundPort: number - /** Backend ID (ID of the backend the frontend should pass traffic to). */ + /** + * Backend ID (ID of the backend the frontend should pass traffic to). + */ backendId: string - /** Maximum allowed inactivity time on the client side. */ + /** + * Maximum allowed inactivity time on the client side. + */ timeoutClient?: string - /** @deprecated Certificate ID, deprecated in favor of certificate_ids array. */ + /** + * @deprecated Certificate ID, deprecated in favor of certificate_ids array. + */ certificateId?: string - /** List of SSL/TLS certificate IDs to bind to the frontend. */ + /** + * List of SSL/TLS certificate IDs to bind to the frontend. + */ certificateIds?: string[] - /** Defines whether to enable HTTP/3 protocol on the frontend. */ + /** + * Defines whether to enable HTTP/3 protocol on the frontend. + */ enableHttp3: boolean /** - * Rate limit for new connections established on this frontend. Use 0 value to - * disable, else value is connections per second. + * Rate limit for new connections established on this frontend. Use 0 value to disable, else value is connections per second. */ connectionRateLimit?: number } export type CreateIpRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion /** - * @deprecated Organization ID of the Organization where the IP address should - * be created. + * @deprecated Organization ID of the Organization where the IP address should be created. * - * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' - * could be set. + * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' could be set. */ organizationId?: string /** * Project ID of the Project where the IP address should be created. * - * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' - * could be set. + * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' could be set. */ projectId?: string - /** Reverse DNS (domain name) for the IP address. */ + /** + * Reverse DNS (domain name) for the IP address. + */ reverse?: string - /** If true, creates a Flexible IP with an ipv6 address. */ + /** + * If true, creates a Flexible IP with an ipv6 address. + */ isIpv6: boolean - /** List of tags for the IP. */ + /** + * List of tags for the IP. + */ tags?: string[] } export type CreateLbRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion /** * @deprecated Scaleway Organization to create the Load Balancer in. * - * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' - * could be set. + * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' could be set. */ organizationId?: string /** * Scaleway Project to create the Load Balancer in. * - * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' - * could be set. + * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' could be set. */ projectId?: string - /** Name for the Load Balancer. */ + /** + * Name for the Load Balancer. + */ name?: string - /** Description for the Load Balancer. */ + /** + * Description for the Load Balancer. + */ description: string /** - * @deprecated ID of an existing flexible IP address to attach to the Load - * Balancer. + * @deprecated ID of an existing flexible IP address to attach to the Load Balancer. */ ipId?: string /** - * Defines whether to automatically assign a flexible public IP to the Load - * Balancer. Default value is `true` (assign). + * Defines whether to automatically assign a flexible public IP to the Load Balancer. Default value is `true` (assign). */ assignFlexibleIp?: boolean /** - * Defines whether to automatically assign a flexible public IPv6 to the Load - * Balancer. Default value is `false` (do not assign). + * Defines whether to automatically assign a flexible public IPv6 to the Load Balancer. Default value is `false` (do not assign). */ assignFlexibleIpv6?: boolean - /** List of IP IDs to attach to the Load Balancer. */ + /** + * List of IP IDs to attach to the Load Balancer. + */ ipIds?: string[] - /** List of tags for the Load Balancer. */ + /** + * List of tags for the Load Balancer. + */ tags?: string[] /** - * Load Balancer commercial offer type. Use the Load Balancer types endpoint - * to retrieve a list of available offer types. + * Load Balancer commercial offer type. Use the Load Balancer types endpoint to retrieve a list of available offer types. */ type: string /** - * Determines the minimal SSL version which needs to be supported on the - * client side, in an SSL/TLS offloading context. Intermediate is suitable for - * general-purpose servers with a variety of clients, recommended for almost - * all systems. Modern is suitable for services with clients that support TLS - * 1.3 and do not need backward compatibility. Old is compatible with a small - * number of very old clients and should be used only as a last resort. + * Determines the minimal SSL version which needs to be supported on the client side, in an SSL/TLS offloading context. Intermediate is suitable for general-purpose servers with a variety of clients, recommended for almost all systems. Modern is suitable for services with clients that support TLS 1.3 and do not need backward compatibility. Old is compatible with a small number of very old clients and should be used only as a last resort. */ sslCompatibilityLevel?: SSLCompatibilityLevel } export type CreateRouteRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the source frontend to create the route on. */ + /** + * ID of the source frontend to create the route on. + */ frontendId: string - /** ID of the target backend for the route. */ + /** + * ID of the target backend for the route. + */ backendId: string /** - * Object defining the match condition for a route to be applied. If an - * incoming client session matches the specified condition (i.e. it has a - * matching SNI value or HTTP Host header value), it will be passed to the - * target backend. + * Object defining the match condition for a route to be applied. If an incoming client session matches the specified condition (i.e. it has a matching SNI value or HTTP Host header value), it will be passed to the target backend. */ match?: RouteMatch } -/** Create a new alert subscriber (webhook or email). */ +/** + * Create a new alert subscriber (webhook or email). + */ export type CreateSubscriberRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Subscriber name. */ + /** + * Subscriber name. + */ name: string /** * Email address configuration. * - * One-of ('config'): at most one of 'emailConfig', 'webhookConfig' could be - * set. + * One-of ('config'): at most one of 'emailConfig', 'webhookConfig' could be set. */ emailConfig?: SubscriberEmailConfig /** * WebHook URI configuration. * - * One-of ('config'): at most one of 'emailConfig', 'webhookConfig' could be - * set. + * One-of ('config'): at most one of 'emailConfig', 'webhookConfig' could be set. */ webhookConfig?: SubscriberWebhookConfig /** * @deprecated Organization ID to create the subscriber in. * - * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' - * could be set. + * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' could be set. */ organizationId?: string /** * Project ID to create the subscriber in. * - * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' - * could be set. + * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' could be set. */ projectId?: string } export type DeleteAclRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ACL ID. */ + /** + * ACL ID. + */ aclId: string } export type DeleteBackendRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the backend to delete. */ + /** + * ID of the backend to delete. + */ backendId: string } export type DeleteCertificateRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Certificate ID. */ + /** + * Certificate ID. + */ certificateId: string } export type DeleteFrontendRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the frontend to delete. */ + /** + * ID of the frontend to delete. + */ frontendId: string } export type DeleteLbRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the Load Balancer to delete. */ + /** + * ID of the Load Balancer to delete. + */ lbId: string /** - * Defines whether the Load Balancer's flexible IP should be deleted. Set to - * true to release the flexible IP, or false to keep it available in your - * account for future Load Balancers. + * Defines whether the Load Balancer's flexible IP should be deleted. Set to true to release the flexible IP, or false to keep it available in your account for future Load Balancers. */ releaseIp: boolean } export type DeleteRouteRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Route ID. */ + /** + * Route ID. + */ routeId: string } export type DeleteSubscriberRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Subscriber ID. */ + /** + * Subscriber ID. + */ subscriberId: string } export type DetachPrivateNetworkRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Load balancer ID. */ + /** + * Load balancer ID. + */ lbId: string - /** Set your instance private network id. */ + /** + * Set your instance private network id. + */ privateNetworkId: string } export type GetAclRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ACL ID. */ + /** + * ACL ID. + */ aclId: string } export type GetBackendRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Backend ID. */ + /** + * Backend ID. + */ backendId: string } export type GetCertificateRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Certificate ID. */ + /** + * Certificate ID. + */ certificateId: string } export type GetFrontendRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Frontend ID. */ + /** + * Frontend ID. + */ frontendId: string } export type GetIpRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** IP address ID. */ + /** + * IP address ID. + */ ipId: string } export type GetLbRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Load Balancer ID. */ + /** + * Load Balancer ID. + */ lbId: string } -/** Get Load Balancer stats. */ +/** + * Get Load Balancer stats. + */ export type GetLbStatsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Load Balancer ID. */ + /** + * Load Balancer ID. + */ lbId: string - /** ID of the backend. */ + /** + * ID of the backend. + */ backendId?: string } export type GetRouteRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Route ID. */ + /** + * Route ID. + */ routeId: string } export type GetSubscriberRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Subscriber ID. */ + /** + * Subscriber ID. + */ subscriberId: string } export interface LbStats { - /** List of objects containing Load Balancer statistics. */ + /** + * List of objects containing Load Balancer statistics. + */ backendServersStats: BackendServerStats[] } export interface ListAclResponse { - /** List of ACL objects. */ + /** + * List of ACL objects. + */ acls: Acl[] - /** The total number of objects. */ + /** + * The total number of objects. + */ totalCount: number } export type ListAclsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion /** - * Frontend ID (ACLs attached to this frontend will be returned in the - * response). + * Frontend ID (ACLs attached to this frontend will be returned in the response). */ frontendId: string - /** Sort order of ACLs in the response. */ + /** + * Sort order of ACLs in the response. + */ orderBy?: ListAclRequestOrderBy - /** The page number to return, from the paginated results. */ + /** + * The page number to return, from the paginated results. + */ page?: number - /** The number of ACLs to return. */ + /** + * The number of ACLs to return. + */ pageSize?: number - /** ACL name to filter for. */ + /** + * ACL name to filter for. + */ name?: string } export type ListBackendStatsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Load Balancer ID. */ + /** + * Load Balancer ID. + */ lbId: string - /** The page number to return, from the paginated results. */ + /** + * The page number to return, from the paginated results. + */ page?: number - /** Number of items to return. */ + /** + * Number of items to return. + */ pageSize?: number - /** ID of the backend. */ + /** + * ID of the backend. + */ backendId?: string } export interface ListBackendStatsResponse { - /** List of objects containing backend server statistics. */ + /** + * List of objects containing backend server statistics. + */ backendServersStats: BackendServerStats[] - /** The total number of objects. */ + /** + * The total number of objects. + */ totalCount: number } export type ListBackendsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Load Balancer ID. */ + /** + * Load Balancer ID. + */ lbId: string - /** Name of the backend to filter for. */ + /** + * Name of the backend to filter for. + */ name?: string - /** Sort order of backends in the response. */ + /** + * Sort order of backends in the response. + */ orderBy?: ListBackendsRequestOrderBy - /** The page number to return, from the paginated results. */ + /** + * The page number to return, from the paginated results. + */ page?: number - /** Number of backends to return. */ + /** + * Number of backends to return. + */ pageSize?: number } export interface ListBackendsResponse { - /** List of backend objects of a given Load Balancer. */ + /** + * List of backend objects of a given Load Balancer. + */ backends: Backend[] - /** Total count of backend objects, without pagination. */ + /** + * Total count of backend objects, without pagination. + */ totalCount: number } export type ListCertificatesRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Load Balancer ID. */ + /** + * Load Balancer ID. + */ lbId: string - /** Sort order of certificates in the response. */ + /** + * Sort order of certificates in the response. + */ orderBy?: ListCertificatesRequestOrderBy - /** The page number to return, from the paginated results. */ + /** + * The page number to return, from the paginated results. + */ page?: number - /** Number of certificates to return. */ + /** + * Number of certificates to return. + */ pageSize?: number /** - * Certificate name to filter for, only certificates of this name will be - * returned. + * Certificate name to filter for, only certificates of this name will be returned. */ name?: string } export interface ListCertificatesResponse { - /** List of certificate objects. */ + /** + * List of certificate objects. + */ certificates: Certificate[] - /** The total number of objects. */ + /** + * The total number of objects. + */ totalCount: number } export type ListFrontendsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Load Balancer ID. */ + /** + * Load Balancer ID. + */ lbId: string - /** Name of the frontend to filter for. */ + /** + * Name of the frontend to filter for. + */ name?: string - /** Sort order of frontends in the response. */ + /** + * Sort order of frontends in the response. + */ orderBy?: ListFrontendsRequestOrderBy - /** The page number to return, from the paginated results. */ + /** + * The page number to return, from the paginated results. + */ page?: number - /** Number of frontends to return. */ + /** + * Number of frontends to return. + */ pageSize?: number } export interface ListFrontendsResponse { - /** List of frontend objects of a given Load Balancer. */ + /** + * List of frontend objects of a given Load Balancer. + */ frontends: Frontend[] - /** Total count of frontend objects, without pagination. */ + /** + * Total count of frontend objects, without pagination. + */ totalCount: number } export type ListIPsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** The page number to return, from the paginated results. */ + /** + * The page number to return, from the paginated results. + */ page?: number - /** Number of IP addresses to return. */ + /** + * Number of IP addresses to return. + */ pageSize?: number - /** IP address to filter for. */ + /** + * IP address to filter for. + */ ipAddress?: string /** - * Organization ID to filter for, only Load Balancer IP addresses from this - * Organization will be returned. + * Organization ID to filter for, only Load Balancer IP addresses from this Organization will be returned. */ organizationId?: string /** - * Project ID to filter for, only Load Balancer IP addresses from this Project - * will be returned. + * Project ID to filter for, only Load Balancer IP addresses from this Project will be returned. */ projectId?: string - /** IP type to filter for. */ + /** + * IP type to filter for. + */ ipType?: ListIpsRequestIpType /** - * Tag to filter for, only IPs with one or more matching tags will be - * returned. + * Tag to filter for, only IPs with one or more matching tags will be returned. */ tags?: string[] } export interface ListIpsResponse { - /** List of IP address objects. */ + /** + * List of IP address objects. + */ ips: Ip[] - /** Total count of IP address objects, without pagination. */ + /** + * Total count of IP address objects, without pagination. + */ totalCount: number } export type ListLbPrivateNetworksRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Load Balancer ID. */ + /** + * Load Balancer ID. + */ lbId: string - /** Sort order of Private Network objects in the response. */ + /** + * Sort order of Private Network objects in the response. + */ orderBy?: ListPrivateNetworksRequestOrderBy - /** Number of objects to return. */ + /** + * Number of objects to return. + */ pageSize?: number - /** The page number to return, from the paginated results. */ + /** + * The page number to return, from the paginated results. + */ page?: number } export interface ListLbPrivateNetworksResponse { - /** List of Private Network objects attached to the Load Balancer. */ + /** + * List of Private Network objects attached to the Load Balancer. + */ privateNetwork: PrivateNetwork[] - /** Total number of objects in the response. */ + /** + * Total number of objects in the response. + */ totalCount: number } export type ListLbTypesRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** The page number to return, from the paginated results. */ + /** + * The page number to return, from the paginated results. + */ page?: number - /** The number of items to return. */ + /** + * The number of items to return. + */ pageSize?: number } export interface ListLbTypesResponse { - /** List of Load Balancer commercial offer type objects. */ + /** + * List of Load Balancer commercial offer type objects. + */ lbTypes: LbType[] - /** Total number of Load Balancer offer type objects. */ + /** + * Total number of Load Balancer offer type objects. + */ totalCount: number } export type ListLbsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Load Balancer name to filter for. */ + /** + * Load Balancer name to filter for. + */ name?: string - /** Sort order of Load Balancers in the response. */ + /** + * Sort order of Load Balancers in the response. + */ orderBy?: ListLbsRequestOrderBy - /** Number of Load Balancers to return. */ + /** + * Number of Load Balancers to return. + */ pageSize?: number - /** Page number to return, from the paginated results. */ + /** + * Page number to return, from the paginated results. + */ page?: number /** - * Organization ID to filter for, only Load Balancers from this Organization - * will be returned. + * Organization ID to filter for, only Load Balancers from this Organization will be returned. */ organizationId?: string /** - * Project ID to filter for, only Load Balancers from this Project will be - * returned. + * Project ID to filter for, only Load Balancers from this Project will be returned. */ projectId?: string /** - * Filter by tag, only Load Balancers with one or more matching tags will be - * returned. + * Filter by tag, only Load Balancers with one or more matching tags will be returned. */ tags?: string[] } export interface ListLbsResponse { - /** List of Load Balancer objects. */ + /** + * List of Load Balancer objects. + */ lbs: Lb[] - /** The total number of Load Balancer objects. */ + /** + * The total number of Load Balancer objects. + */ totalCount: number } export type ListRoutesRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Sort order of routes in the response. */ + /** + * Sort order of routes in the response. + */ orderBy?: ListRoutesRequestOrderBy - /** The number of route objects to return. */ + /** + * The number of route objects to return. + */ pageSize?: number - /** The page number to return, from the paginated results. */ + /** + * The page number to return, from the paginated results. + */ page?: number - /** Frontend ID to filter for, only Routes from this Frontend will be returned. */ + /** + * Frontend ID to filter for, only Routes from this Frontend will be returned. + */ frontendId?: string } export interface ListRoutesResponse { - /** List of route objects. */ + /** + * List of route objects. + */ routes: Route[] - /** The total number of route objects. */ + /** + * The total number of route objects. + */ totalCount: number } export type ListSubscriberRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Sort order of subscribers in the response. */ + /** + * Sort order of subscribers in the response. + */ orderBy?: ListSubscriberRequestOrderBy - /** The page number to return, from the paginated results. */ + /** + * The page number to return, from the paginated results. + */ page?: number - /** The number of items to return. */ + /** + * The number of items to return. + */ pageSize?: number - /** Subscriber name to search for. */ + /** + * Subscriber name to search for. + */ name?: string - /** Filter subscribers by Organization ID. */ + /** + * Filter subscribers by Organization ID. + */ organizationId?: string - /** Filter subscribers by Project ID. */ + /** + * Filter subscribers by Project ID. + */ projectId?: string } export interface ListSubscriberResponse { - /** List of subscriber objects. */ + /** + * List of subscriber objects. + */ subscribers: Subscriber[] - /** The total number of objects. */ + /** + * The total number of objects. + */ totalCount: number } export type MigrateLbRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Load Balancer ID. */ + /** + * Load Balancer ID. + */ lbId: string /** - * Load Balancer type to migrate to (use the List all Load Balancer offer - * types endpoint to get a list of available offer types). + * Load Balancer type to migrate to (use the List all Load Balancer offer types endpoint to get a list of available offer types). */ type: string } export type ReleaseIpRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** IP address ID. */ + /** + * IP address ID. + */ ipId: string } export type RemoveBackendServersRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Backend ID. */ + /** + * Backend ID. + */ backendId: string - /** List of IP addresses to remove from backend servers. */ + /** + * List of IP addresses to remove from backend servers. + */ serverIp: string[] } export interface SetAclsResponse { - /** List of ACL objects. */ + /** + * List of ACL objects. + */ acls: Acl[] - /** The total number of ACL objects. */ + /** + * The total number of ACL objects. + */ totalCount: number } export type SetBackendServersRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Backend ID. */ + /** + * Backend ID. + */ backendId: string /** - * List of IP addresses for backend servers. Any other existing backend - * servers will be removed. + * List of IP addresses for backend servers. Any other existing backend servers will be removed. */ serverIp: string[] } export type SubscribeToLbRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Load Balancer ID. */ + /** + * Load Balancer ID. + */ lbId: string - /** Subscriber ID. */ + /** + * Subscriber ID. + */ subscriberId: string } export type UnsubscribeFromLbRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Load Balancer ID. */ + /** + * Load Balancer ID. + */ lbId: string } export type UpdateAclRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ACL ID. */ + /** + * ACL ID. + */ aclId: string - /** ACL name. */ + /** + * ACL name. + */ name: string - /** Action to take when incoming traffic matches an ACL filter. */ + /** + * Action to take when incoming traffic matches an ACL filter. + */ action: AclAction /** - * ACL match filter object. One of `ip_subnet` or `http_filter` & - * `http_filter_value` are required. + * ACL match filter object. One of `ip_subnet` or `http_filter` & `http_filter_value` are required. */ match?: AclMatch /** - * Priority of this ACL (ACLs are applied in ascending order, 0 is the first - * ACL executed). + * Priority of this ACL (ACLs are applied in ascending order, 0 is the first ACL executed). */ index: number - /** ACL description. */ + /** + * ACL description. + */ description?: string } export type UpdateBackendRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Backend ID. */ + /** + * Backend ID. + */ backendId: string - /** Backend name. */ + /** + * Backend name. + */ name: string /** - * Protocol to be used by the backend when forwarding traffic to backend - * servers. + * Protocol to be used by the backend when forwarding traffic to backend servers. */ forwardProtocol: Protocol - /** Port to be used by the backend when forwarding traffic to backend servers. */ + /** + * Port to be used by the backend when forwarding traffic to backend servers. + */ forwardPort: number /** - * Load balancing algorithm to be used when determining which backend server - * to forward new traffic to. + * Load balancing algorithm to be used when determining which backend server to forward new traffic to. */ forwardPortAlgorithm: ForwardPortAlgorithm /** - * Defines whether to activate sticky sessions (binding a particular session - * to a particular backend server) and the method to use if so. None disables - * sticky sessions. Cookie-based uses an HTTP cookie to stick a session to a - * backend server. Table-based uses the source (client) IP address to stick a - * session to a backend server. + * Defines whether to activate sticky sessions (binding a particular session to a particular backend server) and the method to use if so. None disables sticky sessions. Cookie-based uses an HTTP cookie to stick a session to a backend server. Table-based uses the source (client) IP address to stick a session to a backend server. */ stickySessions: StickySessionsType - /** Cookie name for cookie-based sticky sessions. */ + /** + * Cookie name for cookie-based sticky sessions. + */ stickySessionsCookieName: string - /** @deprecated Deprecated in favor of proxy_protocol field. */ + /** + * @deprecated Deprecated in favor of proxy_protocol field. + */ sendProxyV2?: boolean - /** Maximum allowed time for a backend server to process a request. */ + /** + * Maximum allowed time for a backend server to process a request. + */ timeoutServer?: string - /** Maximum allowed time for establishing a connection to a backend server. */ + /** + * Maximum allowed time for establishing a connection to a backend server. + */ timeoutConnect?: string /** - * Maximum allowed tunnel inactivity time after Websocket is established - * (takes precedence over client and server timeout). + * Maximum allowed tunnel inactivity time after Websocket is established (takes precedence over client and server timeout). */ timeoutTunnel?: string - /** Action to take when a backend server is marked as down. */ + /** + * Action to take when a backend server is marked as down. + */ onMarkedDownAction?: OnMarkedDownAction /** - * Protocol to use between the Load Balancer and backend servers. Allows the - * backend servers to be informed of the client's real IP address. The PROXY - * protocol must be supported by the backend servers' software. + * Protocol to use between the Load Balancer and backend servers. Allows the backend servers to be informed of the client's real IP address. The PROXY protocol must be supported by the backend servers' software. */ proxyProtocol?: ProxyProtocol /** - * Scaleway Object Storage bucket website to be served as failover if all - * backend servers are down, e.g. - * failover-website.s3-website.fr-par.scw.cloud. + * Scaleway Object Storage bucket website to be served as failover if all backend servers are down, e.g. failover-website.s3-website.fr-par.scw.cloud. */ failoverHost?: string /** - * Defines whether to enable SSL bridging between the Load Balancer and - * backend servers. + * Defines whether to enable SSL bridging between the Load Balancer and backend servers. */ sslBridging?: boolean - /** Defines whether the server certificate verification should be ignored. */ + /** + * Defines whether the server certificate verification should be ignored. + */ ignoreSslServerVerify?: boolean - /** Whether to use another backend server on each attempt. */ + /** + * Whether to use another backend server on each attempt. + */ redispatchAttemptCount?: number - /** Number of retries when a backend server connection failed. */ + /** + * Number of retries when a backend server connection failed. + */ maxRetries?: number - /** Maximum number of connections allowed per backend server. */ + /** + * Maximum number of connections allowed per backend server. + */ maxConnections?: number /** - * Maximum time for a request to be left pending in queue when - * `max_connections` is reached. + * Maximum time for a request to be left pending in queue when `max_connections` is reached. */ timeoutQueue?: string } export type UpdateCertificateRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Certificate ID. */ + /** + * Certificate ID. + */ certificateId: string - /** Certificate name. */ + /** + * Certificate name. + */ name: string } export type UpdateFrontendRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Frontend ID. */ + /** + * Frontend ID. + */ frontendId: string - /** Frontend name. */ + /** + * Frontend name. + */ name: string - /** Port the frontend should listen on. */ + /** + * Port the frontend should listen on. + */ inboundPort: number - /** Backend ID (ID of the backend the frontend should pass traffic to). */ + /** + * Backend ID (ID of the backend the frontend should pass traffic to). + */ backendId: string - /** Maximum allowed inactivity time on the client side. */ + /** + * Maximum allowed inactivity time on the client side. + */ timeoutClient?: string - /** @deprecated Certificate ID, deprecated in favor of certificate_ids array. */ + /** + * @deprecated Certificate ID, deprecated in favor of certificate_ids array. + */ certificateId?: string - /** List of SSL/TLS certificate IDs to bind to the frontend. */ + /** + * List of SSL/TLS certificate IDs to bind to the frontend. + */ certificateIds?: string[] - /** Defines whether to enable HTTP/3 protocol on the frontend. */ + /** + * Defines whether to enable HTTP/3 protocol on the frontend. + */ enableHttp3: boolean /** - * Rate limit for new connections established on this frontend. Use 0 value to - * disable, else value is connections per second. + * Rate limit for new connections established on this frontend. Use 0 value to disable, else value is connections per second. */ connectionRateLimit?: number } export type UpdateHealthCheckRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Backend ID. */ + /** + * Backend ID. + */ backendId: string - /** Port to use for the backend server health check. */ + /** + * Port to use for the backend server health check. + */ port: number - /** Time to wait between two consecutive health checks. */ + /** + * Time to wait between two consecutive health checks. + */ checkDelay?: string - /** Maximum time a backend server has to reply to the health check. */ + /** + * Maximum time a backend server has to reply to the health check. + */ checkTimeout?: string /** - * Number of consecutive unsuccessful health checks after which the server - * will be considered dead. + * Number of consecutive unsuccessful health checks after which the server will be considered dead. */ checkMaxRetries: number - /** Defines whether proxy protocol should be activated for the health check. */ + /** + * Defines whether proxy protocol should be activated for the health check. + */ checkSendProxy: boolean /** * Object to configure a basic TCP health check. * - * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', - * 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' - * could be set. + * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' could be set. */ tcpConfig?: HealthCheckTcpConfig /** - * Object to configure a MySQL health check. The check requires MySQL >=3.22 - * or <9.0. For older or newer versions, use a TCP health check. + * Object to configure a MySQL health check. The check requires MySQL >=3.22 or <9.0. For older or newer versions, use a TCP health check. * - * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', - * 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' - * could be set. + * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' could be set. */ mysqlConfig?: HealthCheckMysqlConfig /** * Object to configure a PostgreSQL health check. * - * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', - * 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' - * could be set. + * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' could be set. */ pgsqlConfig?: HealthCheckPgsqlConfig /** - * Object to configure an LDAP health check. The response is analyzed to find - * the LDAPv3 response message. + * Object to configure an LDAP health check. The response is analyzed to find the LDAPv3 response message. * - * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', - * 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' - * could be set. + * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' could be set. */ ldapConfig?: HealthCheckLdapConfig /** - * Object to configure a Redis health check. The response is analyzed to find - * the +PONG response message. + * Object to configure a Redis health check. The response is analyzed to find the +PONG response message. * - * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', - * 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' - * could be set. + * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' could be set. */ redisConfig?: HealthCheckRedisConfig /** * Object to configure an HTTP health check. * - * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', - * 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' - * could be set. + * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' could be set. */ httpConfig?: HealthCheckHttpConfig /** * Object to configure an HTTPS health check. * - * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', - * 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' - * could be set. + * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' could be set. */ httpsConfig?: HealthCheckHttpsConfig /** - * Time to wait between two consecutive health checks when a backend server is - * in a transient state (going UP or DOWN). + * Time to wait between two consecutive health checks when a backend server is in a transient state (going UP or DOWN). */ transientCheckDelay?: string } export type UpdateIpRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** IP address ID. */ + /** + * IP address ID. + */ ipId: string - /** Reverse DNS (domain name) for the IP address. */ + /** + * Reverse DNS (domain name) for the IP address. + */ reverse?: string - /** ID of the server on which to attach the flexible IP. */ + /** + * ID of the server on which to attach the flexible IP. + */ lbId?: string - /** List of tags for the IP. */ + /** + * List of tags for the IP. + */ tags?: string[] } export type UpdateLbRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Load Balancer ID. */ + /** + * Load Balancer ID. + */ lbId: string - /** Load Balancer name. */ + /** + * Load Balancer name. + */ name: string - /** Load Balancer description. */ + /** + * Load Balancer description. + */ description: string - /** List of tags for the Load Balancer. */ + /** + * List of tags for the Load Balancer. + */ tags?: string[] /** - * Determines the minimal SSL version which needs to be supported on the - * client side, in an SSL/TLS offloading context. Intermediate is suitable for - * general-purpose servers with a variety of clients, recommended for almost - * all systems. Modern is suitable for services with clients that support TLS - * 1.3 and don't need backward compatibility. Old is compatible with a small - * number of very old clients and should be used only as a last resort. + * Determines the minimal SSL version which needs to be supported on the client side, in an SSL/TLS offloading context. Intermediate is suitable for general-purpose servers with a variety of clients, recommended for almost all systems. Modern is suitable for services with clients that support TLS 1.3 and don't need backward compatibility. Old is compatible with a small number of very old clients and should be used only as a last resort. */ sslCompatibilityLevel?: SSLCompatibilityLevel } export type UpdateRouteRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Route ID. */ + /** + * Route ID. + */ routeId: string - /** ID of the target backend for the route. */ + /** + * ID of the target backend for the route. + */ backendId: string /** - * Object defining the match condition for a route to be applied. If an - * incoming client session matches the specified condition (i.e. it has a - * matching SNI value or HTTP Host header value), it will be passed to the - * target backend. + * Object defining the match condition for a route to be applied. If an incoming client session matches the specified condition (i.e. it has a matching SNI value or HTTP Host header value), it will be passed to the target backend. */ match?: RouteMatch } export type UpdateSubscriberRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Subscriber ID. */ + /** + * Subscriber ID. + */ subscriberId: string - /** Subscriber name. */ + /** + * Subscriber name. + */ name: string /** * Email address configuration. * - * One-of ('config'): at most one of 'emailConfig', 'webhookConfig' could be - * set. + * One-of ('config'): at most one of 'emailConfig', 'webhookConfig' could be set. */ emailConfig?: SubscriberEmailConfig /** * Webhook URI configuration. * - * One-of ('config'): at most one of 'emailConfig', 'webhookConfig' could be - * set. + * One-of ('config'): at most one of 'emailConfig', 'webhookConfig' could be set. */ webhookConfig?: SubscriberWebhookConfig } export type ZonedApiAddBackendServersRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Backend ID. */ + /** + * Backend ID. + */ backendId: string - /** List of IP addresses to add to backend servers. */ + /** + * List of IP addresses to add to backend servers. + */ serverIp: string[] } export type ZonedApiAttachPrivateNetworkRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Load Balancer ID. */ + /** + * Load Balancer ID. + */ lbId: string - /** Private Network ID. */ + /** + * Private Network ID. + */ privateNetworkId: string /** - * @deprecated Object containing an array of a local IP address for the Load - * Balancer on this Private Network. + * @deprecated Object containing an array of a local IP address for the Load Balancer on this Private Network. * - * One-of ('config'): at most one of 'staticConfig', 'dhcpConfig', - * 'ipamConfig' could be set. + * One-of ('config'): at most one of 'staticConfig', 'dhcpConfig', 'ipamConfig' could be set. */ staticConfig?: PrivateNetworkStaticConfig /** * @deprecated Defines whether to let DHCP assign IP addresses. * - * One-of ('config'): at most one of 'staticConfig', 'dhcpConfig', - * 'ipamConfig' could be set. + * One-of ('config'): at most one of 'staticConfig', 'dhcpConfig', 'ipamConfig' could be set. */ dhcpConfig?: PrivateNetworkDHCPConfig /** * @deprecated For internal use only. * - * One-of ('config'): at most one of 'staticConfig', 'dhcpConfig', - * 'ipamConfig' could be set. + * One-of ('config'): at most one of 'staticConfig', 'dhcpConfig', 'ipamConfig' could be set. */ ipamConfig?: PrivateNetworkIpamConfig /** - * IPAM ID of a pre-reserved IP address to assign to the Load Balancer on this - * Private Network. In the future, it will be possible to specify multiple IPs - * in this field (IPv4 and IPv6), for now only one ID of an IPv4 address is - * expected. When null, a new private IP address is created for the Load - * Balancer on this Private Network. + * IPAM ID of a pre-reserved IP address to assign to the Load Balancer on this Private Network. In the future, it will be possible to specify multiple IPs in this field (IPv4 and IPv6), for now only one ID of an IPv4 address is expected. When null, a new private IP address is created for the Load Balancer on this Private Network. */ ipamIds?: string[] } -/** Add an ACL to a Load Balancer frontend. */ +/** + * Add an ACL to a Load Balancer frontend. + */ export type ZonedApiCreateAclRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Frontend ID to attach the ACL to. */ + /** + * Frontend ID to attach the ACL to. + */ frontendId: string - /** ACL name. */ + /** + * ACL name. + */ name?: string - /** Action to take when incoming traffic matches an ACL filter. */ + /** + * Action to take when incoming traffic matches an ACL filter. + */ action: AclAction /** - * ACL match filter object. One of `ip_subnet` or `http_filter` & - * `http_filter_value` are required. + * ACL match filter object. One of `ip_subnet` or `http_filter` & `http_filter_value` are required. */ match?: AclMatch /** - * Priority of this ACL (ACLs are applied in ascending order, 0 is the first - * ACL executed). + * Priority of this ACL (ACLs are applied in ascending order, 0 is the first ACL executed). */ index: number - /** ACL description. */ + /** + * ACL description. + */ description: string } export type ZonedApiCreateBackendRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Load Balancer ID. */ + /** + * Load Balancer ID. + */ lbId: string - /** Name for the backend. */ + /** + * Name for the backend. + */ name?: string /** - * Protocol to be used by the backend when forwarding traffic to backend - * servers. + * Protocol to be used by the backend when forwarding traffic to backend servers. */ forwardProtocol: Protocol - /** Port to be used by the backend when forwarding traffic to backend servers. */ + /** + * Port to be used by the backend when forwarding traffic to backend servers. + */ forwardPort: number /** - * Load balancing algorithm to be used when determining which backend server - * to forward new traffic to. + * Load balancing algorithm to be used when determining which backend server to forward new traffic to. */ forwardPortAlgorithm: ForwardPortAlgorithm /** - * Defines whether to activate sticky sessions (binding a particular session - * to a particular backend server) and the method to use if so. None disables - * sticky sessions. Cookie-based uses an HTTP cookie TO stick a session to a - * backend server. Table-based uses the source (client) IP address to stick a - * session to a backend server. + * Defines whether to activate sticky sessions (binding a particular session to a particular backend server) and the method to use if so. None disables sticky sessions. Cookie-based uses an HTTP cookie TO stick a session to a backend server. Table-based uses the source (client) IP address to stick a session to a backend server. */ stickySessions: StickySessionsType - /** Cookie name for cookie-based sticky sessions. */ + /** + * Cookie name for cookie-based sticky sessions. + */ stickySessionsCookieName: string /** - * Object defining the health check to be carried out by the backend when - * checking the status and health of backend servers. + * Object defining the health check to be carried out by the backend when checking the status and health of backend servers. */ healthCheck: HealthCheck /** - * List of backend server IP addresses (IPv4 or IPv6) the backend should - * forward traffic to. + * List of backend server IP addresses (IPv4 or IPv6) the backend should forward traffic to. */ serverIp: string[] - /** @deprecated Deprecated in favor of proxy_protocol field. */ + /** + * @deprecated Deprecated in favor of proxy_protocol field. + */ sendProxyV2?: boolean - /** Maximum allowed time for a backend server to process a request. */ + /** + * Maximum allowed time for a backend server to process a request. + */ timeoutServer?: string - /** Maximum allowed time for establishing a connection to a backend server. */ + /** + * Maximum allowed time for establishing a connection to a backend server. + */ timeoutConnect?: string /** - * Maximum allowed tunnel inactivity time after Websocket is established - * (takes precedence over client and server timeout). + * Maximum allowed tunnel inactivity time after Websocket is established (takes precedence over client and server timeout). */ timeoutTunnel?: string - /** Action to take when a backend server is marked as down. */ + /** + * Action to take when a backend server is marked as down. + */ onMarkedDownAction?: OnMarkedDownAction /** - * Protocol to use between the Load Balancer and backend servers. Allows the - * backend servers to be informed of the client's real IP address. The PROXY - * protocol must be supported by the backend servers' software. + * Protocol to use between the Load Balancer and backend servers. Allows the backend servers to be informed of the client's real IP address. The PROXY protocol must be supported by the backend servers' software. */ proxyProtocol?: ProxyProtocol /** - * Scaleway Object Storage bucket website to be served as failover if all - * backend servers are down, e.g. - * failover-website.s3-website.fr-par.scw.cloud. + * Scaleway Object Storage bucket website to be served as failover if all backend servers are down, e.g. failover-website.s3-website.fr-par.scw.cloud. */ failoverHost?: string /** - * Defines whether to enable SSL bridging between the Load Balancer and - * backend servers. + * Defines whether to enable SSL bridging between the Load Balancer and backend servers. */ sslBridging?: boolean - /** Defines whether the server certificate verification should be ignored. */ + /** + * Defines whether the server certificate verification should be ignored. + */ ignoreSslServerVerify?: boolean - /** Whether to use another backend server on each attempt. */ + /** + * Whether to use another backend server on each attempt. + */ redispatchAttemptCount?: number - /** Number of retries when a backend server connection failed. */ + /** + * Number of retries when a backend server connection failed. + */ maxRetries?: number - /** Maximum number of connections allowed per backend server. */ + /** + * Maximum number of connections allowed per backend server. + */ maxConnections?: number /** - * Maximum time for a request to be left pending in queue when - * `max_connections` is reached. + * Maximum time for a request to be left pending in queue when `max_connections` is reached. */ timeoutQueue?: string } export type ZonedApiCreateCertificateRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Load Balancer ID. */ + /** + * Load Balancer ID. + */ lbId: string - /** Name for the certificate. */ + /** + * Name for the certificate. + */ name?: string /** * Object to define a new Let's Encrypt certificate to be generated. * - * One-of ('type'): at most one of 'letsencrypt', 'customCertificate' could be - * set. + * One-of ('type'): at most one of 'letsencrypt', 'customCertificate' could be set. */ letsencrypt?: CreateCertificateRequestLetsencryptConfig /** * Object to define an existing custom certificate to be imported. * - * One-of ('type'): at most one of 'letsencrypt', 'customCertificate' could be - * set. + * One-of ('type'): at most one of 'letsencrypt', 'customCertificate' could be set. */ customCertificate?: CreateCertificateRequestCustomCertificate } export type ZonedApiCreateFrontendRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Load Balancer ID (ID of the Load Balancer to attach the frontend to). */ + /** + * Load Balancer ID (ID of the Load Balancer to attach the frontend to). + */ lbId: string - /** Name for the frontend. */ + /** + * Name for the frontend. + */ name?: string - /** Port the frontend should listen on. */ + /** + * Port the frontend should listen on. + */ inboundPort: number - /** Backend ID (ID of the backend the frontend should pass traffic to). */ + /** + * Backend ID (ID of the backend the frontend should pass traffic to). + */ backendId: string - /** Maximum allowed inactivity time on the client side. */ + /** + * Maximum allowed inactivity time on the client side. + */ timeoutClient?: string - /** @deprecated Certificate ID, deprecated in favor of certificate_ids array. */ + /** + * @deprecated Certificate ID, deprecated in favor of certificate_ids array. + */ certificateId?: string - /** List of SSL/TLS certificate IDs to bind to the frontend. */ + /** + * List of SSL/TLS certificate IDs to bind to the frontend. + */ certificateIds?: string[] - /** Defines whether to enable HTTP/3 protocol on the frontend. */ + /** + * Defines whether to enable HTTP/3 protocol on the frontend. + */ enableHttp3: boolean /** - * Rate limit for new connections established on this frontend. Use 0 value to - * disable, else value is connections per second. + * Rate limit for new connections established on this frontend. Use 0 value to disable, else value is connections per second. */ connectionRateLimit?: number } export type ZonedApiCreateIpRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone /** - * @deprecated Organization ID of the Organization where the IP address should - * be created. + * @deprecated Organization ID of the Organization where the IP address should be created. * - * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' - * could be set. + * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' could be set. */ organizationId?: string /** * Project ID of the Project where the IP address should be created. * - * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' - * could be set. + * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' could be set. */ projectId?: string - /** Reverse DNS (domain name) for the IP address. */ + /** + * Reverse DNS (domain name) for the IP address. + */ reverse?: string - /** If true, creates a Flexible IP with an ipv6 address. */ + /** + * If true, creates a Flexible IP with an ipv6 address. + */ isIpv6: boolean - /** List of tags for the IP. */ + /** + * List of tags for the IP. + */ tags?: string[] } export type ZonedApiCreateLbRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone /** * @deprecated Scaleway Organization to create the Load Balancer in. * - * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' - * could be set. + * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' could be set. */ organizationId?: string /** * Scaleway Project to create the Load Balancer in. * - * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' - * could be set. + * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' could be set. */ projectId?: string - /** Name for the Load Balancer. */ + /** + * Name for the Load Balancer. + */ name?: string - /** Description for the Load Balancer. */ + /** + * Description for the Load Balancer. + */ description: string /** - * @deprecated ID of an existing flexible IP address to attach to the Load - * Balancer. + * @deprecated ID of an existing flexible IP address to attach to the Load Balancer. */ ipId?: string /** - * Defines whether to automatically assign a flexible public IP to the Load - * Balancer. Default value is `true` (assign). + * Defines whether to automatically assign a flexible public IP to the Load Balancer. Default value is `true` (assign). */ assignFlexibleIp?: boolean /** - * Defines whether to automatically assign a flexible public IPv6 to the Load - * Balancer. Default value is `false` (do not assign). + * Defines whether to automatically assign a flexible public IPv6 to the Load Balancer. Default value is `false` (do not assign). */ assignFlexibleIpv6?: boolean - /** List of IP IDs to attach to the Load Balancer. */ + /** + * List of IP IDs to attach to the Load Balancer. + */ ipIds?: string[] - /** List of tags for the Load Balancer. */ + /** + * List of tags for the Load Balancer. + */ tags?: string[] /** - * Load Balancer commercial offer type. Use the Load Balancer types endpoint - * to retrieve a list of available offer types. + * Load Balancer commercial offer type. Use the Load Balancer types endpoint to retrieve a list of available offer types. */ type: string /** - * Determines the minimal SSL version which needs to be supported on the - * client side, in an SSL/TLS offloading context. Intermediate is suitable for - * general-purpose servers with a variety of clients, recommended for almost - * all systems. Modern is suitable for services with clients that support TLS - * 1.3 and do not need backward compatibility. Old is compatible with a small - * number of very old clients and should be used only as a last resort. + * Determines the minimal SSL version which needs to be supported on the client side, in an SSL/TLS offloading context. Intermediate is suitable for general-purpose servers with a variety of clients, recommended for almost all systems. Modern is suitable for services with clients that support TLS 1.3 and do not need backward compatibility. Old is compatible with a small number of very old clients and should be used only as a last resort. */ sslCompatibilityLevel?: SSLCompatibilityLevel } export type ZonedApiCreateRouteRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the source frontend to create the route on. */ + /** + * ID of the source frontend to create the route on. + */ frontendId: string - /** ID of the target backend for the route. */ + /** + * ID of the target backend for the route. + */ backendId: string /** - * Object defining the match condition for a route to be applied. If an - * incoming client session matches the specified condition (i.e. it has a - * matching SNI value or HTTP Host header value), it will be passed to the - * target backend. + * Object defining the match condition for a route to be applied. If an incoming client session matches the specified condition (i.e. it has a matching SNI value or HTTP Host header value), it will be passed to the target backend. */ match?: RouteMatch } -/** Create a new alert subscriber (webhook or email). */ +/** + * Create a new alert subscriber (webhook or email). + */ export type ZonedApiCreateSubscriberRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Subscriber name. */ + /** + * Subscriber name. + */ name: string /** * Email address configuration. * - * One-of ('config'): at most one of 'emailConfig', 'webhookConfig' could be - * set. + * One-of ('config'): at most one of 'emailConfig', 'webhookConfig' could be set. */ emailConfig?: SubscriberEmailConfig /** * WebHook URI configuration. * - * One-of ('config'): at most one of 'emailConfig', 'webhookConfig' could be - * set. + * One-of ('config'): at most one of 'emailConfig', 'webhookConfig' could be set. */ webhookConfig?: SubscriberWebhookConfig /** * @deprecated Organization ID to create the subscriber in. * - * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' - * could be set. + * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' could be set. */ organizationId?: string /** * Project ID to create the subscriber in. * - * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' - * could be set. + * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' could be set. */ projectId?: string } export type ZonedApiDeleteAclRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ACL ID. */ + /** + * ACL ID. + */ aclId: string } export type ZonedApiDeleteBackendRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the backend to delete. */ + /** + * ID of the backend to delete. + */ backendId: string } export type ZonedApiDeleteCertificateRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Certificate ID. */ + /** + * Certificate ID. + */ certificateId: string } export type ZonedApiDeleteFrontendRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the frontend to delete. */ + /** + * ID of the frontend to delete. + */ frontendId: string } export type ZonedApiDeleteLbRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the Load Balancer to delete. */ + /** + * ID of the Load Balancer to delete. + */ lbId: string /** - * Defines whether the Load Balancer's flexible IP should be deleted. Set to - * true to release the flexible IP, or false to keep it available in your - * account for future Load Balancers. + * Defines whether the Load Balancer's flexible IP should be deleted. Set to true to release the flexible IP, or false to keep it available in your account for future Load Balancers. */ releaseIp: boolean } export type ZonedApiDeleteRouteRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Route ID. */ + /** + * Route ID. + */ routeId: string } export type ZonedApiDeleteSubscriberRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Subscriber ID. */ + /** + * Subscriber ID. + */ subscriberId: string } export type ZonedApiDetachPrivateNetworkRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Load balancer ID. */ + /** + * Load balancer ID. + */ lbId: string - /** Set your instance private network id. */ + /** + * Set your instance private network id. + */ privateNetworkId: string } export type ZonedApiGetAclRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ACL ID. */ + /** + * ACL ID. + */ aclId: string } export type ZonedApiGetBackendRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Backend ID. */ + /** + * Backend ID. + */ backendId: string } export type ZonedApiGetCertificateRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Certificate ID. */ + /** + * Certificate ID. + */ certificateId: string } export type ZonedApiGetFrontendRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Frontend ID. */ + /** + * Frontend ID. + */ frontendId: string } export type ZonedApiGetIpRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** IP address ID. */ + /** + * IP address ID. + */ ipId: string } export type ZonedApiGetLbRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Load Balancer ID. */ + /** + * Load Balancer ID. + */ lbId: string } -/** Get Load Balancer stats. */ +/** + * Get Load Balancer stats. + */ export type ZonedApiGetLbStatsRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Load Balancer ID. */ + /** + * Load Balancer ID. + */ lbId: string - /** ID of the backend. */ + /** + * ID of the backend. + */ backendId?: string } export type ZonedApiGetRouteRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Route ID. */ + /** + * Route ID. + */ routeId: string } export type ZonedApiGetSubscriberRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Subscriber ID. */ + /** + * Subscriber ID. + */ subscriberId: string } export type ZonedApiListAclsRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone /** - * Frontend ID (ACLs attached to this frontend will be returned in the - * response). + * Frontend ID (ACLs attached to this frontend will be returned in the response). */ frontendId: string - /** Sort order of ACLs in the response. */ + /** + * Sort order of ACLs in the response. + */ orderBy?: ListAclRequestOrderBy - /** The page number to return, from the paginated results. */ + /** + * The page number to return, from the paginated results. + */ page?: number - /** The number of ACLs to return. */ + /** + * The number of ACLs to return. + */ pageSize?: number - /** ACL name to filter for. */ + /** + * ACL name to filter for. + */ name?: string } export type ZonedApiListBackendStatsRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Load Balancer ID. */ + /** + * Load Balancer ID. + */ lbId: string - /** The page number to return, from the paginated results. */ + /** + * The page number to return, from the paginated results. + */ page?: number - /** Number of items to return. */ + /** + * Number of items to return. + */ pageSize?: number - /** ID of the backend. */ + /** + * ID of the backend. + */ backendId?: string } export type ZonedApiListBackendsRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Load Balancer ID. */ + /** + * Load Balancer ID. + */ lbId: string - /** Name of the backend to filter for. */ + /** + * Name of the backend to filter for. + */ name?: string - /** Sort order of backends in the response. */ + /** + * Sort order of backends in the response. + */ orderBy?: ListBackendsRequestOrderBy - /** The page number to return, from the paginated results. */ + /** + * The page number to return, from the paginated results. + */ page?: number - /** Number of backends to return. */ + /** + * Number of backends to return. + */ pageSize?: number } export type ZonedApiListCertificatesRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Load Balancer ID. */ + /** + * Load Balancer ID. + */ lbId: string - /** Sort order of certificates in the response. */ + /** + * Sort order of certificates in the response. + */ orderBy?: ListCertificatesRequestOrderBy - /** The page number to return, from the paginated results. */ + /** + * The page number to return, from the paginated results. + */ page?: number - /** Number of certificates to return. */ + /** + * Number of certificates to return. + */ pageSize?: number /** - * Certificate name to filter for, only certificates of this name will be - * returned. + * Certificate name to filter for, only certificates of this name will be returned. */ name?: string } export type ZonedApiListFrontendsRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Load Balancer ID. */ + /** + * Load Balancer ID. + */ lbId: string - /** Name of the frontend to filter for. */ + /** + * Name of the frontend to filter for. + */ name?: string - /** Sort order of frontends in the response. */ + /** + * Sort order of frontends in the response. + */ orderBy?: ListFrontendsRequestOrderBy - /** The page number to return, from the paginated results. */ + /** + * The page number to return, from the paginated results. + */ page?: number - /** Number of frontends to return. */ + /** + * Number of frontends to return. + */ pageSize?: number } export type ZonedApiListIPsRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** The page number to return, from the paginated results. */ + /** + * The page number to return, from the paginated results. + */ page?: number - /** Number of IP addresses to return. */ + /** + * Number of IP addresses to return. + */ pageSize?: number - /** IP address to filter for. */ + /** + * IP address to filter for. + */ ipAddress?: string /** - * Organization ID to filter for, only Load Balancer IP addresses from this - * Organization will be returned. + * Organization ID to filter for, only Load Balancer IP addresses from this Organization will be returned. */ organizationId?: string /** - * Project ID to filter for, only Load Balancer IP addresses from this Project - * will be returned. + * Project ID to filter for, only Load Balancer IP addresses from this Project will be returned. */ projectId?: string - /** IP type to filter for. */ + /** + * IP type to filter for. + */ ipType?: ListIpsRequestIpType /** - * Tag to filter for, only IPs with one or more matching tags will be - * returned. + * Tag to filter for, only IPs with one or more matching tags will be returned. */ tags?: string[] } export type ZonedApiListLbPrivateNetworksRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Load Balancer ID. */ + /** + * Load Balancer ID. + */ lbId: string - /** Sort order of Private Network objects in the response. */ + /** + * Sort order of Private Network objects in the response. + */ orderBy?: ListPrivateNetworksRequestOrderBy - /** Number of objects to return. */ + /** + * Number of objects to return. + */ pageSize?: number - /** The page number to return, from the paginated results. */ + /** + * The page number to return, from the paginated results. + */ page?: number } export type ZonedApiListLbTypesRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** The page number to return, from the paginated results. */ + /** + * The page number to return, from the paginated results. + */ page?: number - /** The number of items to return. */ + /** + * The number of items to return. + */ pageSize?: number } export type ZonedApiListLbsRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Load Balancer name to filter for. */ + /** + * Load Balancer name to filter for. + */ name?: string - /** Sort order of Load Balancers in the response. */ + /** + * Sort order of Load Balancers in the response. + */ orderBy?: ListLbsRequestOrderBy - /** Number of Load Balancers to return. */ + /** + * Number of Load Balancers to return. + */ pageSize?: number - /** Page number to return, from the paginated results. */ + /** + * Page number to return, from the paginated results. + */ page?: number /** - * Organization ID to filter for, only Load Balancers from this Organization - * will be returned. + * Organization ID to filter for, only Load Balancers from this Organization will be returned. */ organizationId?: string /** - * Project ID to filter for, only Load Balancers from this Project will be - * returned. + * Project ID to filter for, only Load Balancers from this Project will be returned. */ projectId?: string /** - * Filter by tag, only Load Balancers with one or more matching tags will be - * returned. + * Filter by tag, only Load Balancers with one or more matching tags will be returned. */ tags?: string[] } export type ZonedApiListRoutesRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Sort order of routes in the response. */ + /** + * Sort order of routes in the response. + */ orderBy?: ListRoutesRequestOrderBy - /** The number of route objects to return. */ + /** + * The number of route objects to return. + */ pageSize?: number - /** The page number to return, from the paginated results. */ + /** + * The page number to return, from the paginated results. + */ page?: number - /** Frontend ID to filter for, only Routes from this Frontend will be returned. */ + /** + * Frontend ID to filter for, only Routes from this Frontend will be returned. + */ frontendId?: string } export type ZonedApiListSubscriberRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Sort order of subscribers in the response. */ + /** + * Sort order of subscribers in the response. + */ orderBy?: ListSubscriberRequestOrderBy - /** The page number to return, from the paginated results. */ + /** + * The page number to return, from the paginated results. + */ page?: number - /** The number of items to return. */ + /** + * The number of items to return. + */ pageSize?: number - /** Subscriber name to search for. */ + /** + * Subscriber name to search for. + */ name?: string - /** Filter subscribers by Organization ID. */ + /** + * Filter subscribers by Organization ID. + */ organizationId?: string - /** Filter subscribers by Project ID. */ + /** + * Filter subscribers by Project ID. + */ projectId?: string } export type ZonedApiMigrateLbRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Load Balancer ID. */ + /** + * Load Balancer ID. + */ lbId: string /** - * Load Balancer type to migrate to (use the List all Load Balancer offer - * types endpoint to get a list of available offer types). + * Load Balancer type to migrate to (use the List all Load Balancer offer types endpoint to get a list of available offer types). */ type: string } export type ZonedApiReleaseIpRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** IP address ID. */ + /** + * IP address ID. + */ ipId: string } export type ZonedApiRemoveBackendServersRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Backend ID. */ + /** + * Backend ID. + */ backendId: string - /** List of IP addresses to remove from backend servers. */ + /** + * List of IP addresses to remove from backend servers. + */ serverIp: string[] } export type ZonedApiSetAclsRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Frontend ID. */ + /** + * Frontend ID. + */ frontendId: string /** - * List of ACLs for this frontend. Any other existing ACLs on this frontend - * will be removed. + * List of ACLs for this frontend. Any other existing ACLs on this frontend will be removed. */ acls: AclSpec[] } export type ZonedApiSetBackendServersRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Backend ID. */ + /** + * Backend ID. + */ backendId: string /** - * List of IP addresses for backend servers. Any other existing backend - * servers will be removed. + * List of IP addresses for backend servers. Any other existing backend servers will be removed. */ serverIp: string[] } export type ZonedApiSubscribeToLbRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Load Balancer ID. */ + /** + * Load Balancer ID. + */ lbId: string - /** Subscriber ID. */ + /** + * Subscriber ID. + */ subscriberId: string } export type ZonedApiUnsubscribeFromLbRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Load Balancer ID. */ + /** + * Load Balancer ID. + */ lbId: string } export type ZonedApiUpdateAclRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ACL ID. */ + /** + * ACL ID. + */ aclId: string - /** ACL name. */ + /** + * ACL name. + */ name: string - /** Action to take when incoming traffic matches an ACL filter. */ + /** + * Action to take when incoming traffic matches an ACL filter. + */ action: AclAction /** - * ACL match filter object. One of `ip_subnet` or `http_filter` & - * `http_filter_value` are required. + * ACL match filter object. One of `ip_subnet` or `http_filter` & `http_filter_value` are required. */ match?: AclMatch /** - * Priority of this ACL (ACLs are applied in ascending order, 0 is the first - * ACL executed). + * Priority of this ACL (ACLs are applied in ascending order, 0 is the first ACL executed). */ index: number - /** ACL description. */ + /** + * ACL description. + */ description?: string } export type ZonedApiUpdateBackendRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Backend ID. */ + /** + * Backend ID. + */ backendId: string - /** Backend name. */ + /** + * Backend name. + */ name: string /** - * Protocol to be used by the backend when forwarding traffic to backend - * servers. + * Protocol to be used by the backend when forwarding traffic to backend servers. */ forwardProtocol: Protocol - /** Port to be used by the backend when forwarding traffic to backend servers. */ + /** + * Port to be used by the backend when forwarding traffic to backend servers. + */ forwardPort: number /** - * Load balancing algorithm to be used when determining which backend server - * to forward new traffic to. + * Load balancing algorithm to be used when determining which backend server to forward new traffic to. */ forwardPortAlgorithm: ForwardPortAlgorithm /** - * Defines whether to activate sticky sessions (binding a particular session - * to a particular backend server) and the method to use if so. None disables - * sticky sessions. Cookie-based uses an HTTP cookie to stick a session to a - * backend server. Table-based uses the source (client) IP address to stick a - * session to a backend server. + * Defines whether to activate sticky sessions (binding a particular session to a particular backend server) and the method to use if so. None disables sticky sessions. Cookie-based uses an HTTP cookie to stick a session to a backend server. Table-based uses the source (client) IP address to stick a session to a backend server. */ stickySessions: StickySessionsType - /** Cookie name for cookie-based sticky sessions. */ + /** + * Cookie name for cookie-based sticky sessions. + */ stickySessionsCookieName: string - /** @deprecated Deprecated in favor of proxy_protocol field. */ + /** + * @deprecated Deprecated in favor of proxy_protocol field. + */ sendProxyV2?: boolean - /** Maximum allowed time for a backend server to process a request. */ + /** + * Maximum allowed time for a backend server to process a request. + */ timeoutServer?: string - /** Maximum allowed time for establishing a connection to a backend server. */ + /** + * Maximum allowed time for establishing a connection to a backend server. + */ timeoutConnect?: string /** - * Maximum allowed tunnel inactivity time after Websocket is established - * (takes precedence over client and server timeout). + * Maximum allowed tunnel inactivity time after Websocket is established (takes precedence over client and server timeout). */ timeoutTunnel?: string - /** Action to take when a backend server is marked as down. */ + /** + * Action to take when a backend server is marked as down. + */ onMarkedDownAction?: OnMarkedDownAction /** - * Protocol to use between the Load Balancer and backend servers. Allows the - * backend servers to be informed of the client's real IP address. The PROXY - * protocol must be supported by the backend servers' software. + * Protocol to use between the Load Balancer and backend servers. Allows the backend servers to be informed of the client's real IP address. The PROXY protocol must be supported by the backend servers' software. */ proxyProtocol?: ProxyProtocol /** - * Scaleway Object Storage bucket website to be served as failover if all - * backend servers are down, e.g. - * failover-website.s3-website.fr-par.scw.cloud. + * Scaleway Object Storage bucket website to be served as failover if all backend servers are down, e.g. failover-website.s3-website.fr-par.scw.cloud. */ failoverHost?: string /** - * Defines whether to enable SSL bridging between the Load Balancer and - * backend servers. + * Defines whether to enable SSL bridging between the Load Balancer and backend servers. */ sslBridging?: boolean - /** Defines whether the server certificate verification should be ignored. */ + /** + * Defines whether the server certificate verification should be ignored. + */ ignoreSslServerVerify?: boolean - /** Whether to use another backend server on each attempt. */ + /** + * Whether to use another backend server on each attempt. + */ redispatchAttemptCount?: number - /** Number of retries when a backend server connection failed. */ + /** + * Number of retries when a backend server connection failed. + */ maxRetries?: number - /** Maximum number of connections allowed per backend server. */ + /** + * Maximum number of connections allowed per backend server. + */ maxConnections?: number /** - * Maximum time for a request to be left pending in queue when - * `max_connections` is reached. + * Maximum time for a request to be left pending in queue when `max_connections` is reached. */ timeoutQueue?: string } export type ZonedApiUpdateCertificateRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Certificate ID. */ + /** + * Certificate ID. + */ certificateId: string - /** Certificate name. */ + /** + * Certificate name. + */ name: string } export type ZonedApiUpdateFrontendRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Frontend ID. */ + /** + * Frontend ID. + */ frontendId: string - /** Frontend name. */ + /** + * Frontend name. + */ name: string - /** Port the frontend should listen on. */ + /** + * Port the frontend should listen on. + */ inboundPort: number - /** Backend ID (ID of the backend the frontend should pass traffic to). */ + /** + * Backend ID (ID of the backend the frontend should pass traffic to). + */ backendId: string - /** Maximum allowed inactivity time on the client side. */ + /** + * Maximum allowed inactivity time on the client side. + */ timeoutClient?: string - /** @deprecated Certificate ID, deprecated in favor of certificate_ids array. */ + /** + * @deprecated Certificate ID, deprecated in favor of certificate_ids array. + */ certificateId?: string - /** List of SSL/TLS certificate IDs to bind to the frontend. */ + /** + * List of SSL/TLS certificate IDs to bind to the frontend. + */ certificateIds?: string[] - /** Defines whether to enable HTTP/3 protocol on the frontend. */ + /** + * Defines whether to enable HTTP/3 protocol on the frontend. + */ enableHttp3: boolean /** - * Rate limit for new connections established on this frontend. Use 0 value to - * disable, else value is connections per second. + * Rate limit for new connections established on this frontend. Use 0 value to disable, else value is connections per second. */ connectionRateLimit?: number } export type ZonedApiUpdateHealthCheckRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Backend ID. */ + /** + * Backend ID. + */ backendId: string - /** Port to use for the backend server health check. */ + /** + * Port to use for the backend server health check. + */ port: number - /** Time to wait between two consecutive health checks. */ + /** + * Time to wait between two consecutive health checks. + */ checkDelay?: string - /** Maximum time a backend server has to reply to the health check. */ + /** + * Maximum time a backend server has to reply to the health check. + */ checkTimeout?: string /** - * Number of consecutive unsuccessful health checks after which the server - * will be considered dead. + * Number of consecutive unsuccessful health checks after which the server will be considered dead. */ checkMaxRetries: number - /** Defines whether proxy protocol should be activated for the health check. */ + /** + * Defines whether proxy protocol should be activated for the health check. + */ checkSendProxy: boolean /** * Object to configure a basic TCP health check. * - * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', - * 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' - * could be set. + * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' could be set. */ tcpConfig?: HealthCheckTcpConfig /** - * Object to configure a MySQL health check. The check requires MySQL >=3.22 - * or <9.0. For older or newer versions, use a TCP health check. + * Object to configure a MySQL health check. The check requires MySQL >=3.22 or <9.0. For older or newer versions, use a TCP health check. * - * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', - * 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' - * could be set. + * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' could be set. */ mysqlConfig?: HealthCheckMysqlConfig /** * Object to configure a PostgreSQL health check. * - * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', - * 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' - * could be set. + * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' could be set. */ pgsqlConfig?: HealthCheckPgsqlConfig /** - * Object to configure an LDAP health check. The response is analyzed to find - * the LDAPv3 response message. + * Object to configure an LDAP health check. The response is analyzed to find the LDAPv3 response message. * - * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', - * 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' - * could be set. + * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' could be set. */ ldapConfig?: HealthCheckLdapConfig /** - * Object to configure a Redis health check. The response is analyzed to find - * the +PONG response message. + * Object to configure a Redis health check. The response is analyzed to find the +PONG response message. * - * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', - * 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' - * could be set. + * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' could be set. */ redisConfig?: HealthCheckRedisConfig /** * Object to configure an HTTP health check. * - * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', - * 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' - * could be set. + * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' could be set. */ httpConfig?: HealthCheckHttpConfig /** * Object to configure an HTTPS health check. * - * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', - * 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' - * could be set. + * One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' could be set. */ httpsConfig?: HealthCheckHttpsConfig /** - * Time to wait between two consecutive health checks when a backend server is - * in a transient state (going UP or DOWN). + * Time to wait between two consecutive health checks when a backend server is in a transient state (going UP or DOWN). */ transientCheckDelay?: string } export type ZonedApiUpdateIpRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** IP address ID. */ + /** + * IP address ID. + */ ipId: string - /** Reverse DNS (domain name) for the IP address. */ + /** + * Reverse DNS (domain name) for the IP address. + */ reverse?: string - /** ID of the server on which to attach the flexible IP. */ + /** + * ID of the server on which to attach the flexible IP. + */ lbId?: string - /** List of tags for the IP. */ + /** + * List of tags for the IP. + */ tags?: string[] } export type ZonedApiUpdateLbRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Load Balancer ID. */ + /** + * Load Balancer ID. + */ lbId: string - /** Load Balancer name. */ + /** + * Load Balancer name. + */ name: string - /** Load Balancer description. */ + /** + * Load Balancer description. + */ description: string - /** List of tags for the Load Balancer. */ + /** + * List of tags for the Load Balancer. + */ tags?: string[] /** - * Determines the minimal SSL version which needs to be supported on the - * client side, in an SSL/TLS offloading context. Intermediate is suitable for - * general-purpose servers with a variety of clients, recommended for almost - * all systems. Modern is suitable for services with clients that support TLS - * 1.3 and don't need backward compatibility. Old is compatible with a small - * number of very old clients and should be used only as a last resort. + * Determines the minimal SSL version which needs to be supported on the client side, in an SSL/TLS offloading context. Intermediate is suitable for general-purpose servers with a variety of clients, recommended for almost all systems. Modern is suitable for services with clients that support TLS 1.3 and don't need backward compatibility. Old is compatible with a small number of very old clients and should be used only as a last resort. */ sslCompatibilityLevel?: SSLCompatibilityLevel } export type ZonedApiUpdateRouteRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Route ID. */ + /** + * Route ID. + */ routeId: string - /** ID of the target backend for the route. */ + /** + * ID of the target backend for the route. + */ backendId: string /** - * Object defining the match condition for a route to be applied. If an - * incoming client session matches the specified condition (i.e. it has a - * matching SNI value or HTTP Host header value), it will be passed to the - * target backend. + * Object defining the match condition for a route to be applied. If an incoming client session matches the specified condition (i.e. it has a matching SNI value or HTTP Host header value), it will be passed to the target backend. */ match?: RouteMatch } export type ZonedApiUpdateSubscriberRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Subscriber ID. */ + /** + * Subscriber ID. + */ subscriberId: string - /** Subscriber name. */ + /** + * Subscriber name. + */ name: string /** * Email address configuration. * - * One-of ('config'): at most one of 'emailConfig', 'webhookConfig' could be - * set. + * One-of ('config'): at most one of 'emailConfig', 'webhookConfig' could be set. */ emailConfig?: SubscriberEmailConfig /** * Webhook URI configuration. * - * One-of ('config'): at most one of 'emailConfig', 'webhookConfig' could be - * set. + * One-of ('config'): at most one of 'emailConfig', 'webhookConfig' could be set. */ webhookConfig?: SubscriberWebhookConfig } diff --git a/packages/clients/src/api/llm_inference/index.gen.ts b/packages/clients/src/api/llm_inference/index.gen.ts index 886270369..79692e383 100644 --- a/packages/clients/src/api/llm_inference/index.gen.ts +++ b/packages/clients/src/api/llm_inference/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1beta1 from './v1beta1/index.gen' diff --git a/packages/clients/src/api/marketplace/index.gen.ts b/packages/clients/src/api/marketplace/index.gen.ts index 40f288ff0..21ef57b6c 100644 --- a/packages/clients/src/api/marketplace/index.gen.ts +++ b/packages/clients/src/api/marketplace/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v2 from './v2/index.gen' diff --git a/packages/clients/src/api/mnq/index.gen.ts b/packages/clients/src/api/mnq/index.gen.ts index 886270369..79692e383 100644 --- a/packages/clients/src/api/mnq/index.gen.ts +++ b/packages/clients/src/api/mnq/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1beta1 from './v1beta1/index.gen' diff --git a/packages/clients/src/api/mnq/v1beta1/index.gen.ts b/packages/clients/src/api/mnq/v1beta1/index.gen.ts index 0bc8b8f72..82440fa58 100644 --- a/packages/clients/src/api/mnq/v1beta1/index.gen.ts +++ b/packages/clients/src/api/mnq/v1beta1/index.gen.ts @@ -1,6 +1,10 @@ // This file was automatically generated. DO NOT EDIT. // If you have any remark or suggestion do not hesitate to open an issue. -export { NatsAPI, SnsAPI, SqsAPI } from './api.gen' +export { + NatsAPI, + SnsAPI, + SqsAPI, +} from './api.gen' export type { File, ListNatsAccountsRequestOrderBy, diff --git a/packages/clients/src/api/mongodb/index.gen.ts b/packages/clients/src/api/mongodb/index.gen.ts index 6dec29b44..4e5e04061 100644 --- a/packages/clients/src/api/mongodb/index.gen.ts +++ b/packages/clients/src/api/mongodb/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1alpha1 from './v1alpha1/index.gen' diff --git a/packages/clients/src/api/qaas/index.gen.ts b/packages/clients/src/api/qaas/index.gen.ts index 6dec29b44..4e5e04061 100644 --- a/packages/clients/src/api/qaas/index.gen.ts +++ b/packages/clients/src/api/qaas/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1alpha1 from './v1alpha1/index.gen' diff --git a/packages/clients/src/api/rdb/index.gen.ts b/packages/clients/src/api/rdb/index.gen.ts index a86d42c0b..aff657f1e 100644 --- a/packages/clients/src/api/rdb/index.gen.ts +++ b/packages/clients/src/api/rdb/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1 from './v1/index.gen' diff --git a/packages/clients/src/api/redis/index.gen.ts b/packages/clients/src/api/redis/index.gen.ts index a86d42c0b..aff657f1e 100644 --- a/packages/clients/src/api/redis/index.gen.ts +++ b/packages/clients/src/api/redis/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1 from './v1/index.gen' diff --git a/packages/clients/src/api/registry/index.gen.ts b/packages/clients/src/api/registry/index.gen.ts index a86d42c0b..aff657f1e 100644 --- a/packages/clients/src/api/registry/index.gen.ts +++ b/packages/clients/src/api/registry/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1 from './v1/index.gen' diff --git a/packages/clients/src/api/secret/index.gen.ts b/packages/clients/src/api/secret/index.gen.ts index 72d281d6b..6a15a4900 100644 --- a/packages/clients/src/api/secret/index.gen.ts +++ b/packages/clients/src/api/secret/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1alpha1 from './v1alpha1/index.gen' diff --git a/packages/clients/src/api/serverless_sqldb/index.gen.ts b/packages/clients/src/api/serverless_sqldb/index.gen.ts index 6dec29b44..4e5e04061 100644 --- a/packages/clients/src/api/serverless_sqldb/index.gen.ts +++ b/packages/clients/src/api/serverless_sqldb/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1alpha1 from './v1alpha1/index.gen' diff --git a/packages/clients/src/api/tem/index.gen.ts b/packages/clients/src/api/tem/index.gen.ts index 6dec29b44..4e5e04061 100644 --- a/packages/clients/src/api/tem/index.gen.ts +++ b/packages/clients/src/api/tem/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1alpha1 from './v1alpha1/index.gen' diff --git a/packages/clients/src/api/test/index.gen.ts b/packages/clients/src/api/test/index.gen.ts index a86d42c0b..aff657f1e 100644 --- a/packages/clients/src/api/test/index.gen.ts +++ b/packages/clients/src/api/test/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1 from './v1/index.gen' diff --git a/packages/clients/src/api/vpc/index.gen.ts b/packages/clients/src/api/vpc/index.gen.ts index bfc9cec79..2c3742e31 100644 --- a/packages/clients/src/api/vpc/index.gen.ts +++ b/packages/clients/src/api/vpc/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1 from './v1/index.gen' diff --git a/packages/clients/src/api/vpcgw/index.gen.ts b/packages/clients/src/api/vpcgw/index.gen.ts index bfc9cec79..2c3742e31 100644 --- a/packages/clients/src/api/vpcgw/index.gen.ts +++ b/packages/clients/src/api/vpcgw/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1 from './v1/index.gen' diff --git a/packages/clients/src/api/webhosting/index.gen.ts b/packages/clients/src/api/webhosting/index.gen.ts index a86d42c0b..aff657f1e 100644 --- a/packages/clients/src/api/webhosting/index.gen.ts +++ b/packages/clients/src/api/webhosting/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1 from './v1/index.gen'