Class API

constructor

• new API(client): IPAM.v1.API

• Parameters

  • client: Client

  Returns IPAM.v1.API

Static ReadonlyLOCALITIES

attachIP

• attachIP(request): Promise<IPAM.v1.IP>

• Attach IP to custom resource. Attach an existing reserved IP from a Private Network subnet to a custom, named resource via its MAC address. An example of a custom resource is a virtual machine hosted on an Elastic Metal server. Do not use this method for attaching IP addresses to standard Scaleway resources as it will fail - see the relevant product API for an equivalent method.

  Parameters

  • request: Readonly<AttachIPRequest>

    The request AttachIPRequest

  Returns Promise<IPAM.v1.IP>

  A Promise of IP

bookIP

• bookIP(request): Promise<IPAM.v1.IP>

• Reserve a new IP. Reserve a new IP from the specified source. Currently IPs can only be reserved from a Private Network.

  Parameters

  • request: Readonly<BookIPRequest>

    The request BookIPRequest

  Returns Promise<IPAM.v1.IP>

  A Promise of IP

detachIP

• detachIP(request): Promise<IPAM.v1.IP>

• Detach IP from a custom resource. Detach a private IP from a custom resource. An example of a custom resource is a virtual machine hosted on an Elastic Metal server. Do not use this method for detaching IP addresses from standard Scaleway resources (e.g. Instances, Load Balancers) as it will fail - see the relevant product API for an equivalent method.

  Parameters

  • request: Readonly<DetachIPRequest>

    The request DetachIPRequest

  Returns Promise<IPAM.v1.IP>

  A Promise of IP

getIP

• getIP(request): Promise<IPAM.v1.IP>

• Get an IP. Retrieve details of an existing IP, specified by its IP ID.

  Parameters

  • request: Readonly<IPAM.v1.GetIPRequest>

    The request GetIPRequest

  Returns Promise<IPAM.v1.IP>

  A Promise of IP

listIPs

• listIPs(request?): Promise<IPAM.v1.ListIPsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<IPAM.v1.IP[], void, void>);
      all: (() => Promise<IPAM.v1.IP[]>);
  }

• List existing IPs. List existing IPs in the specified region using various filters. For example, you can filter for IPs within a specified Private Network, or for public IPs within a specified Project. By default, the IPs 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<IPAM.v1.ListIPsRequest> = {}

    The request ListIPsRequest

  Returns Promise<IPAM.v1.ListIPsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<IPAM.v1.IP[], void, void>);
      all: (() => Promise<IPAM.v1.IP[]>);
  }

  A Promise of ListIPsResponse

moveIP

• moveIP(request): Promise<IPAM.v1.IP>

• Move IP to a custom resource. Move an existing reserved private IP from one custom resource (e.g. a virtual machine hosted on an Elastic Metal server) to another custom resource. This will detach it from the first resource, and attach it to the second. Do not use this method for moving IP addresses between standard Scaleway resources (e.g. Instances, Load Balancers) as it will fail - see the relevant product API for an equivalent method.

  Parameters

  • request: Readonly<MoveIPRequest>

    The request MoveIPRequest

  Returns Promise<IPAM.v1.IP>

  A Promise of IP

releaseIP

• releaseIP(request): Promise<void>

• Release an IP. Release an IP not currently attached to a resource, and returns it to the available IP pool.

  Parameters

  • request: Readonly<ReleaseIPRequest>

    The request ReleaseIPRequest

  Returns Promise<void>

releaseIPSet

• releaseIPSet(request?): Promise<void>

• Parameters

  • request: Readonly<ReleaseIPSetRequest> = {}

  Returns Promise<void>

updateIP

• updateIP(request): Promise<IPAM.v1.IP>

• Update an IP. Update parameters including tags of the specified IP.

  Parameters

  • request: Readonly<IPAM.v1.UpdateIPRequest>

    The request UpdateIPRequest

  Returns Promise<IPAM.v1.IP>

  A Promise of IP