Class API

Edge Services API.

Hierarchy

API
- API

Constructors

constructor

new API(client: Client): EdgeServices.v1alpha1.API
Parameters
- client: Client
Returns EdgeServices.v1alpha1.API
Inherited from ParentAPI.constructor
- Defined in packages/clients/src/scw/api.ts:9

Methods

createBackendStage

createBackendStage(
request?: Readonly<CreateBackendStageRequest>,
): Promise<BackendStage>
Create backend stage. Create a new backend stage. You must specify either a scaleway_s3 (for a Scaleway Object Storage bucket) or scaleway_lb (for a Scaleway Load Balancer) field to configure the origin.
Parameters
- request: Readonly<CreateBackendStageRequest> = {}
  The request CreateBackendStageRequest
Returns Promise<BackendStage>
A Promise of BackendStage
- Defined in packages/clients/src/api/edge_services/v1alpha1/api.gen.ts:633

createCacheStage

createCacheStage(
request?: Readonly<CreateCacheStageRequest>,
): Promise<CacheStage>
Create cache stage. Create a new cache stage. You must specify the fallback_ttl field to customize the TTL of the cache.
Parameters
- request: Readonly<CreateCacheStageRequest> = {}
  The request CreateCacheStageRequest
Returns Promise<CacheStage>
A Promise of CacheStage
- Defined in packages/clients/src/api/edge_services/v1alpha1/api.gen.ts:525

createDNSStage

createDNSStage(request?: Readonly<CreateDNSStageRequest>): Promise<DNSStage>
Create DNS stage. Create a new DNS stage. You must specify the fqdns field to customize the domain endpoint, using a domain you already own.
Parameters
- request: Readonly<CreateDNSStageRequest> = {}
  The request CreateDNSStageRequest
Returns Promise<DNSStage>
A Promise of DNSStage
- Defined in packages/clients/src/api/edge_services/v1alpha1/api.gen.ts:314

createPipeline

createPipeline(request: Readonly<CreatePipelineRequest>): Promise<Pipeline>
Create pipeline. Create a new pipeline. You must specify a dns_stage_id to form a stage-chain that goes all the way to the backend stage (origin), so the HTTP request will be processed according to the stages you created.
Parameters
- request: Readonly<CreatePipelineRequest>
  The request CreatePipelineRequest
Returns Promise<Pipeline>
A Promise of Pipeline
- Defined in packages/clients/src/api/edge_services/v1alpha1/api.gen.ts:158

createPurgeRequest

createPurgeRequest(
request: Readonly<CreatePurgeRequestRequest>,
): Promise<PurgeRequest>
Create purge request. Create a new purge request. You must specify either the all field (to purge all content) or a list of assets (to define the precise assets to purge).
Parameters
- request: Readonly<CreatePurgeRequestRequest>
  The request CreatePurgeRequestRequest
Returns Promise<PurgeRequest>
A Promise of PurgeRequest
- Defined in packages/clients/src/api/edge_services/v1alpha1/api.gen.ts:765

createTLSStage

createTLSStage(request?: Readonly<CreateTLSStageRequest>): Promise<TLSStage>
Create TLS stage. Create a new TLS stage. You must specify either the secrets or managed_certificate fields to customize the SSL/TLS certificate of your endpoint. Choose secrets if you are using a pre-existing certificate held in Scaleway Secret Manager, or managed_certificate to let Scaleway generate and manage a Let's Encrypt certificate for your customized endpoint.
Parameters
- request: Readonly<CreateTLSStageRequest> = {}
  The request CreateTLSStageRequest
Returns Promise<TLSStage>
A Promise of TLSStage
- Defined in packages/clients/src/api/edge_services/v1alpha1/api.gen.ts:422

deleteBackendStage

deleteBackendStage(request: Readonly<DeleteBackendStageRequest>): Promise<void>
Delete backend stage. Delete an existing backend stage, specified by its backend_stage_id. Deleting a backend stage is permanent, and cannot be undone.
Parameters
- request: Readonly<DeleteBackendStageRequest>
  The request DeleteBackendStageRequest
Returns Promise<void>
- Defined in packages/clients/src/api/edge_services/v1alpha1/api.gen.ts:690

deleteCacheStage

deleteCacheStage(request: Readonly<DeleteCacheStageRequest>): Promise<void>
Delete cache stage. Delete an existing cache stage, specified by its cache_stage_id. Deleting a cache stage is permanent, and cannot be undone.
Parameters
- request: Readonly<DeleteCacheStageRequest>
  The request DeleteCacheStageRequest
Returns Promise<void>
- Defined in packages/clients/src/api/edge_services/v1alpha1/api.gen.ts:583

deleteCurrentPlan

deleteCurrentPlan(request?: Readonly<DeleteCurrentPlanRequest>): Promise<void>
Parameters
- request: Readonly<DeleteCurrentPlanRequest> = {}
Returns Promise<void>
- Defined in packages/clients/src/api/edge_services/v1alpha1/api.gen.ts:861

deleteDNSStage

deleteDNSStage(request: Readonly<DeleteDNSStageRequest>): Promise<void>
Delete DNS stage. Delete an existing DNS stage, specified by its dns_stage_id. Deleting a DNS stage is permanent, and cannot be undone.
Parameters
- request: Readonly<DeleteDNSStageRequest>
  The request DeleteDNSStageRequest
Returns Promise<void>
- Defined in packages/clients/src/api/edge_services/v1alpha1/api.gen.ts:370

deletePipeline

deletePipeline(request: Readonly<DeletePipelineRequest>): Promise<void>
Delete pipeline. Delete an existing pipeline, specified by its pipeline_id. Deleting a pipeline is permanent, and cannot be undone. Note that all stages linked to the pipeline are also deleted.
Parameters
- request: Readonly<DeletePipelineRequest>
  The request DeletePipelineRequest
Returns Promise<void>
- Defined in packages/clients/src/api/edge_services/v1alpha1/api.gen.ts:267

deleteTLSStage

deleteTLSStage(request: Readonly<DeleteTLSStageRequest>): Promise<void>
Delete TLS stage. Delete an existing TLS stage, specified by its tls_stage_id. Deleting a TLS stage is permanent, and cannot be undone.
Parameters
- request: Readonly<DeleteTLSStageRequest>
  The request DeleteTLSStageRequest
Returns Promise<void>
- Defined in packages/clients/src/api/edge_services/v1alpha1/api.gen.ts:479

getBackendStage

getBackendStage(
request: Readonly<GetBackendStageRequest>,
): Promise<BackendStage>
Get backend stage. Retrieve information about an existing backend stage, specified by its backend_stage_id. Its full details, including scaleway_s3 or scaleway_lb, are returned in the response object.
Parameters
- request: Readonly<GetBackendStageRequest>
  The request GetBackendStageRequest
Returns Promise<BackendStage>
A Promise of BackendStage
- Defined in packages/clients/src/api/edge_services/v1alpha1/api.gen.ts:654

getBilling

getBilling(request?: Readonly<GetBillingRequest>): Promise<GetBillingResponse>
Gives information on the currently selected Edge Services subscription plan, resource usage and associated billing information for this calendar month (including whether consumption falls within or exceeds the currently selected subscription plan.).
Parameters
- request: Readonly<GetBillingRequest> = {}
  The request GetBillingRequest
Returns Promise<GetBillingResponse>
A Promise of GetBillingResponse
- Defined in packages/clients/src/api/edge_services/v1alpha1/api.gen.ts:876

getCacheStage

getCacheStage(request: Readonly<GetCacheStageRequest>): Promise<CacheStage>
Get cache stage. Retrieve information about an existing cache stage, specified by its cache_stage_id. Its full details, including Time To Live (TTL), are returned in the response object.
Parameters
- request: Readonly<GetCacheStageRequest>
  The request GetCacheStageRequest
Returns Promise<CacheStage>
A Promise of CacheStage
- Defined in packages/clients/src/api/edge_services/v1alpha1/api.gen.ts:546

getCurrentPlan

getCurrentPlan(
request?: Readonly<GetCurrentPlanRequest>,
): Promise<EdgeServices.v1alpha1.Plan>
Parameters
- request: Readonly<GetCurrentPlanRequest> = {}
Returns Promise<EdgeServices.v1alpha1.Plan>
- Defined in packages/clients/src/api/edge_services/v1alpha1/api.gen.ts:852

getDNSStage

getDNSStage(request: Readonly<GetDNSStageRequest>): Promise<DNSStage>
Get DNS stage. Retrieve information about an existing DNS stage, specified by its dns_stage_id. Its full details, including FQDNs, are returned in the response object.
Parameters
- request: Readonly<GetDNSStageRequest>
  The request GetDNSStageRequest
Returns Promise<DNSStage>
A Promise of DNSStage
- Defined in packages/clients/src/api/edge_services/v1alpha1/api.gen.ts:335

getPipeline

getPipeline(request: Readonly<GetPipelineRequest>): Promise<Pipeline>
Get pipeline. Retrieve information about an existing pipeline, specified by its pipeline_id. Its full details, including errors, are returned in the response object.
Parameters
- request: Readonly<GetPipelineRequest>
  The request GetPipelineRequest
Returns Promise<Pipeline>
A Promise of Pipeline
- Defined in packages/clients/src/api/edge_services/v1alpha1/api.gen.ts:179

getPurgeRequest

getPurgeRequest(
request: Readonly<GetPurgeRequestRequest>,
): Promise<PurgeRequest>
Get purge request. Retrieve information about a purge request, specified by its purge_request_id. Its full details, including status and target, are returned in the response object.
Parameters
- request: Readonly<GetPurgeRequestRequest>
  The request GetPurgeRequestRequest
Returns Promise<PurgeRequest>
A Promise of PurgeRequest
- Defined in packages/clients/src/api/edge_services/v1alpha1/api.gen.ts:786

getTLSStage

getTLSStage(request: Readonly<GetTLSStageRequest>): Promise<TLSStage>
Get TLS stage. Retrieve information about an existing TLS stage, specified by its tls_stage_id. Its full details, including secrets and certificate expiration date are returned in the response object.
Parameters
- request: Readonly<GetTLSStageRequest>
  The request GetTLSStageRequest
Returns Promise<TLSStage>
A Promise of TLSStage
- Defined in packages/clients/src/api/edge_services/v1alpha1/api.gen.ts:443

listBackendStages

listBackendStages(
    request?: Readonly<ListBackendStagesRequest>,
): Promise<ListBackendStagesResponse> & {
    "[asyncIterator]": () => AsyncGenerator<BackendStage[], void, void>;
    all: () => Promise<BackendStage[]>;
}
List backend stages. List all backend stages, for a Scaleway Organization or Scaleway Project. By default, the backend stages returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.
Parameters
- request: Readonly<ListBackendStagesRequest> = {}
  The request ListBackendStagesRequest
Returns Promise<ListBackendStagesResponse> & {
"[asyncIterator]": () => AsyncGenerator<BackendStage[], void, void>;
all: () => Promise<BackendStage[]>;
}
A Promise of ListBackendStagesResponse
- Defined in packages/clients/src/api/edge_services/v1alpha1/api.gen.ts:622

listCacheStages

listCacheStages(
    request?: Readonly<ListCacheStagesRequest>,
): Promise<ListCacheStagesResponse> & {
    "[asyncIterator]": () => AsyncGenerator<CacheStage[], void, void>;
    all: () => Promise<CacheStage[]>;
}
List cache stages. List all cache stages, for a Scaleway Organization or Scaleway Project. By default, the cache stages returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.
Parameters
- request: Readonly<ListCacheStagesRequest> = {}
  The request ListCacheStagesRequest
Returns Promise<ListCacheStagesResponse> & {
"[asyncIterator]": () => AsyncGenerator<CacheStage[], void, void>;
all: () => Promise<CacheStage[]>;
}
A Promise of ListCacheStagesResponse
- Defined in packages/clients/src/api/edge_services/v1alpha1/api.gen.ts:515

listDNSStages

listDNSStages(
    request?: Readonly<ListDNSStagesRequest>,
): Promise<ListDNSStagesResponse> & {
    "[asyncIterator]": () => AsyncGenerator<DNSStage[], void, void>;
    all: () => Promise<DNSStage[]>;
}
List DNS stages. List all DNS stages, for a Scaleway Organization or Scaleway Project. By default, the DNS stages returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.
Parameters
- request: Readonly<ListDNSStagesRequest> = {}
  The request ListDNSStagesRequest
Returns Promise<ListDNSStagesResponse> & {
"[asyncIterator]": () => AsyncGenerator<DNSStage[], void, void>;
all: () => Promise<DNSStage[]>;
}
A Promise of ListDNSStagesResponse
- Defined in packages/clients/src/api/edge_services/v1alpha1/api.gen.ts:304

listPipelines

listPipelines(
    request?: Readonly<ListPipelinesRequest>,
): Promise<ListPipelinesResponse> & {
    "[asyncIterator]": () => AsyncGenerator<Pipeline[], void, void>;
    all: () => Promise<Pipeline[]>;
}
List pipelines. List all pipelines, for a Scaleway Organization or Scaleway Project. By default, the pipelines returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.
Parameters
- request: Readonly<ListPipelinesRequest> = {}
  The request ListPipelinesRequest
Returns Promise<ListPipelinesResponse> & {
"[asyncIterator]": () => AsyncGenerator<Pipeline[], void, void>;
all: () => Promise<Pipeline[]>;
}
A Promise of ListPipelinesResponse
- Defined in packages/clients/src/api/edge_services/v1alpha1/api.gen.ts:147

listPipelinesWithStages

listPipelinesWithStages(
    request?: Readonly<ListPipelinesWithStagesRequest>,
): Promise<ListPipelinesWithStagesResponse> & {
    "[asyncIterator]": () => AsyncGenerator<PipelineStages[], void, void>;
    all: () => Promise<PipelineStages[]>;
}
Parameters
- request: Readonly<ListPipelinesWithStagesRequest> = {}
Returns Promise<ListPipelinesWithStagesResponse> & {
"[asyncIterator]": () => AsyncGenerator<PipelineStages[], void, void>;
all: () => Promise<PipelineStages[]>;
}
- Defined in packages/clients/src/api/edge_services/v1alpha1/api.gen.ts:230

listPlans

listPlans(): Promise<EdgeServices.v1alpha1.ListPlansResponse>
Returns Promise<EdgeServices.v1alpha1.ListPlansResponse>
- Defined in packages/clients/src/api/edge_services/v1alpha1/api.gen.ts:830

listPurgeRequests

listPurgeRequests(
    request?: Readonly<ListPurgeRequestsRequest>,
): Promise<ListPurgeRequestsResponse> & {
    "[asyncIterator]": () => AsyncGenerator<PurgeRequest[], void, void>;
    all: () => Promise<PurgeRequest[]>;
}
List purge requests. List all purge requests, for a Scaleway Organization or Scaleway Project. This enables you to retrieve a history of all previously-made purge requests. By default, the purge requests returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.
Parameters
- request: Readonly<ListPurgeRequestsRequest> = {}
  The request ListPurgeRequestsRequest
Returns Promise<ListPurgeRequestsResponse> & {
"[asyncIterator]": () => AsyncGenerator<PurgeRequest[], void, void>;
all: () => Promise<PurgeRequest[]>;
}
A Promise of ListPurgeRequestsResponse
- Defined in packages/clients/src/api/edge_services/v1alpha1/api.gen.ts:754

listTLSStages

listTLSStages(
    request?: Readonly<ListTLSStagesRequest>,
): Promise<ListTLSStagesResponse> & {
    "[asyncIterator]": () => AsyncGenerator<TLSStage[], void, void>;
    all: () => Promise<TLSStage[]>;
}
List TLS stages. List all TLS stages, for a Scaleway Organization or Scaleway Project. By default, the TLS stages returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.
Parameters
- request: Readonly<ListTLSStagesRequest> = {}
  The request ListTLSStagesRequest
Returns Promise<ListTLSStagesResponse> & {
"[asyncIterator]": () => AsyncGenerator<TLSStage[], void, void>;
all: () => Promise<TLSStage[]>;
}
A Promise of ListTLSStagesResponse
- Defined in packages/clients/src/api/edge_services/v1alpha1/api.gen.ts:408

selectPlan

selectPlan(
request?: Readonly<EdgeServices.v1alpha1.SelectPlanRequest>,
): Promise<EdgeServices.v1alpha1.Plan>
Parameters
- request: Readonly<EdgeServices.v1alpha1.SelectPlanRequest> = {}
Returns Promise<EdgeServices.v1alpha1.Plan>
- Defined in packages/clients/src/api/edge_services/v1alpha1/api.gen.ts:839

updateBackendStage

updateBackendStage(
request: Readonly<UpdateBackendStageRequest>,
): Promise<BackendStage>
Update backend stage. Update the parameters of an existing backend stage, specified by its backend_stage_id.
Parameters
- request: Readonly<UpdateBackendStageRequest>
  The request UpdateBackendStageRequest
Returns Promise<BackendStage>
A Promise of BackendStage
- Defined in packages/clients/src/api/edge_services/v1alpha1/api.gen.ts:670

updateCacheStage

updateCacheStage(
request: Readonly<UpdateCacheStageRequest>,
): Promise<CacheStage>
Update cache stage. Update the parameters of an existing cache stage, specified by its cache_stage_id. Parameters which can be updated include the fallback_ttl and backend_stage_id.
Parameters
- request: Readonly<UpdateCacheStageRequest>
  The request UpdateCacheStageRequest
Returns Promise<CacheStage>
A Promise of CacheStage
- Defined in packages/clients/src/api/edge_services/v1alpha1/api.gen.ts:563

updateDNSStage

updateDNSStage(request: Readonly<UpdateDNSStageRequest>): Promise<DNSStage>
Update DNS stage. Update the parameters of an existing DNS stage, specified by its dns_stage_id.
Parameters
- request: Readonly<UpdateDNSStageRequest>
  The request UpdateDNSStageRequest
Returns Promise<DNSStage>
A Promise of DNSStage
- Defined in packages/clients/src/api/edge_services/v1alpha1/api.gen.ts:351

updatePipeline

updatePipeline(request: Readonly<UpdatePipelineRequest>): Promise<Pipeline>
Update pipeline. Update the parameters of an existing pipeline, specified by its pipeline_id. Parameters which can be updated include the name, description and dns_stage_id.
Parameters
- request: Readonly<UpdatePipelineRequest>
  The request UpdatePipelineRequest
Returns Promise<Pipeline>
A Promise of Pipeline
- Defined in packages/clients/src/api/edge_services/v1alpha1/api.gen.ts:247

updateTLSStage

updateTLSStage(request: Readonly<UpdateTLSStageRequest>): Promise<TLSStage>
Update TLS stage. Update the parameters of an existing TLS stage, specified by its tls_stage_id. Both tls_secrets_config and managed_certificate parameters can be updated.
Parameters
- request: Readonly<UpdateTLSStageRequest>
  The request UpdateTLSStageRequest
Returns Promise<TLSStage>
A Promise of TLSStage
- Defined in packages/clients/src/api/edge_services/v1alpha1/api.gen.ts:460

waitForPipeline

waitForPipeline(
request: Readonly<GetPipelineRequest>,
options?: Readonly<WaitForOptions<Pipeline>>,
): Promise<Pipeline>
Waits for Pipeline to be in a final state.
Parameters
- request: Readonly<GetPipelineRequest>
  The request GetPipelineRequest
- Optionaloptions: Readonly<WaitForOptions<Pipeline>>
  The waiting options
Returns Promise<Pipeline>
A Promise of Pipeline
- Defined in packages/clients/src/api/edge_services/v1alpha1/api.gen.ts:195

waitForPurgeRequest

waitForPurgeRequest(
request: Readonly<GetPurgeRequestRequest>,
options?: Readonly<WaitForOptions<PurgeRequest>>,
): Promise<PurgeRequest>
Waits for PurgeRequest to be in a final state.
Parameters
- request: Readonly<GetPurgeRequestRequest>
  The request GetPurgeRequestRequest
- Optionaloptions: Readonly<WaitForOptions<PurgeRequest>>
  The waiting options
Returns Promise<PurgeRequest>
A Promise of PurgeRequest
- Defined in packages/clients/src/api/edge_services/v1alpha1/api.gen.ts:802

Class API

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns EdgeServices.v1alpha1.API

Methods

checkDomain

Parameters

Returns Promise<CheckDomainResponse>

checkLbOrigin

Parameters

Returns Promise<CheckLbOriginResponse>

checkPEMChain

Parameters

Returns Promise<CheckPEMChainResponse>

createBackendStage

Parameters

Returns Promise<BackendStage>

createCacheStage

Parameters

Returns Promise<CacheStage>

createDNSStage

Parameters

Returns Promise<DNSStage>

createPipeline

Parameters

Returns Promise<Pipeline>

createPurgeRequest

Parameters

Returns Promise<PurgeRequest>

createTLSStage

Parameters

Returns Promise<TLSStage>

deleteBackendStage

Parameters

Returns Promise<void>

deleteCacheStage

Parameters

Returns Promise<void>

deleteCurrentPlan

Parameters

Returns Promise<void>

deleteDNSStage

Parameters

Returns Promise<void>

deletePipeline

Parameters

Returns Promise<void>

deleteTLSStage

Parameters

Returns Promise<void>

getBackendStage

Parameters

Returns Promise<BackendStage>

getBilling

Parameters

Returns Promise<GetBillingResponse>

getCacheStage

Parameters

Returns Promise<CacheStage>

getCurrentPlan

Parameters

Returns Promise<EdgeServices.v1alpha1.Plan>

getDNSStage

Parameters

Returns Promise<DNSStage>

getPipeline

Parameters

Returns Promise<Pipeline>

getPurgeRequest

Parameters

Returns Promise<PurgeRequest>

getTLSStage

Parameters

Returns Promise<TLSStage>

listBackendStages

Returns Promise<ListBackendStagesResponse> & {
"[asyncIterator]": () => AsyncGenerator<BackendStage[], void, void>;
all: () => Promise<BackendStage[]>;
}

Returns Promise<ListCacheStagesResponse> & {
"[asyncIterator]": () => AsyncGenerator<CacheStage[], void, void>;
all: () => Promise<CacheStage[]>;
}

Returns Promise<ListDNSStagesResponse> & {
"[asyncIterator]": () => AsyncGenerator<DNSStage[], void, void>;
all: () => Promise<DNSStage[]>;
}

Returns Promise<ListPipelinesResponse> & {
"[asyncIterator]": () => AsyncGenerator<Pipeline[], void, void>;
all: () => Promise<Pipeline[]>;
}

Returns Promise<ListPipelinesWithStagesResponse> & {
"[asyncIterator]": () => AsyncGenerator<PipelineStages[], void, void>;
all: () => Promise<PipelineStages[]>;
}

Returns Promise<ListPurgeRequestsResponse> & {
"[asyncIterator]": () => AsyncGenerator<PurgeRequest[], void, void>;
all: () => Promise<PurgeRequest[]>;
}

Returns Promise<ListTLSStagesResponse> & {
"[asyncIterator]": () => AsyncGenerator<TLSStage[], void, void>;
all: () => Promise<TLSStage[]>;
}