Type Alias Profile

Profile: {
    accessKey?: string;
    apiURL?: string;
    defaultOrganizationId?: string;
    defaultProjectId?: string;
    defaultRegion?: string;
    defaultZone?: string;
    secretKey?: string;
}

Profile contains information to help instanciating the Scaleway client.

Type declaration

  • OptionalaccessKey?: string

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

  • OptionalapiURL?: 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?: string

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

  • OptionaldefaultProjectId?: string

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

  • OptionaldefaultRegion?: string

    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?: string

    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

  • OptionalsecretKey?: 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.

Settings