Type Alias BookIPRequest

BookIPRequest: {
    address?: string;
    isIpv6: boolean;
    projectId?: string;
    region?: Region;
    resource?: CustomResource;
    source: Source;
    tags?: string[];
}

Type declaration

  • Optionaladdress?: string

    The requested address should not include the subnet mask (/suffix). Note that only the Private Network source allows you to pick a specific IP. If the requested IP is already reserved, then the call will fail.

  • isIpv6: boolean

    Request an IPv6 instead of an IPv4.

  • OptionalprojectId?: string

    When creating an IP in a Private Network, the Project must match the Private Network's Project.

  • Optionalregion?: Region

    Region to target. If none is passed will use default region from the config.

  • Optionalresource?: CustomResource

    Custom resource to attach to the IP being reserved. An example of a custom resource is a virtual machine hosted on an Elastic Metal server. Do not use this for attaching IP addresses to standard Scaleway resources, as it will fail - instead, see the relevant product API for an equivalent method.

  • source: Source

    Source in which to reserve the IP. Not all sources are available for reservation.

  • Optionaltags?: string[]

    Tags for the IP.

Settings