Interface Settings

Settings hold the values of all client options.

interface Settings {
    accessKey?: string;
    apiURL?: string;
    defaultOrganizationId?: string;
    defaultPageSize?: number;
    defaultProjectId?: string;
    defaultRegion?: Region;
    defaultZone?: Zone;
    httpClient: {
        (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
        (input: string | Request | URL, init?: RequestInit): Promise<Response>;
    };
    interceptors: NetworkInterceptors[];
    requestInterceptors?: RequestInterceptor[];
    responseInterceptors?: ResponseInterceptor[];
    secretKey?: string;
    userAgent: string;
}

Hierarchy (View Summary)

Properties

accessKey? apiURL? defaultOrganizationId? defaultPageSize? defaultProjectId? defaultRegion? defaultZone? httpClient interceptors requestInterceptors? responseInterceptors? secretKey? userAgent

Properties

OptionalaccessKey

accessKey?: string

You need an access key and a secret key to connect to Scaleway API. Generate your access key at the following address: https://console.scaleway.com/project/credentials.

OptionalapiURL

apiURL?: string

APIURL overrides the API URL of the Scaleway API to the given URL. Change that if you want to direct requests to a different endpoint.

Default Value

https://api.scaleway.com

OptionaldefaultOrganizationId

defaultOrganizationId?: string

Your organization ID is the identifier of your account inside Scaleway infrastructure.

OptionaldefaultPageSize

defaultPageSize?: number

The default number of results when requesting a paginated resource.

OptionaldefaultProjectId

defaultProjectId?: string

Your project ID is the identifier of the project your resources are attached to.

OptionaldefaultRegion

defaultRegion?: Region

A region is represented as a geographical area such as France (Paris) or the Netherlands (Amsterdam). It can contain multiple availability zones.

Examples: fr-par, nl-ams.

OptionaldefaultZone

defaultZone?: Zone

A region can be split into many availability zones (AZ). Latency between multiple AZ of the same region are low as they have a common network layer.

Examples: fr-par-1, nl-ams-1

httpClient

httpClient: {
    (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
    (input: string | Request | URL, init?: RequestInit): Promise<Response>;
}

HTTP Client doing the requests.

Type declaration

    • (input: URL | RequestInfo, init?: RequestInit): Promise<Response>

    • MDN Reference

      Parameters

      • input: URL | RequestInfo
      • Optionalinit: RequestInit

      Returns Promise<Response>

    • (input: string | Request | URL, init?: RequestInit): Promise<Response>

    • MDN Reference

      Parameters

      • input: string | Request | URL
      • Optionalinit: RequestInit

      Returns Promise<Response>

interceptors

interceptors: NetworkInterceptors[]

The Network interceptors.

OptionalrequestInterceptors

requestInterceptors?: RequestInterceptor[]

The Request interceptors.

Deprecated

Please use interceptors instead.

OptionalresponseInterceptors

responseInterceptors?: ResponseInterceptor[]

The Response interceptors.

Deprecated

Please use interceptors instead.

OptionalsecretKey

secretKey?: string

The secret key is the value that can be used to authenticate against the API (the value used in X-Auth-Token HTTP-header). The secret key MUST remain secret and not given to anyone or published online. Generate your secret key at the following address: https://console.scaleway.com/project/credentials.

userAgent

userAgent: string

The User-Agent sent with each request.

Default Value

scaleway-sdk-js/version

Settings

On This Page

Properties