DatacentersClient

class DatacentersClient(client: Client)[source]
get_all(name: str | None = None) → list[BoundDatacenter][source]

Get all datacenters

Parameters:

name – str (optional) Can be used to filter datacenters by their name.

Returns:

List[BoundDatacenter]

get_by_id(id: int) → BoundDatacenter[source]

Get a specific datacenter by its ID.

Parameters:

id – int

Returns:

BoundDatacenter

get_by_name(name: str) → BoundDatacenter | None[source]

Get datacenter by name

Parameters:

name – str Used to get datacenter by name.

Returns:

BoundDatacenter

get_list(name: str | None = None, page: int | None = None, per_page: int | None = None) → DatacentersPageResult[source]

Get a list of datacenters

Parameters:

  • name – str (optional) Can be used to filter datacenters by their name.

  • page – int (optional) Specifies the page to fetch

  • per_page – int (optional) Specifies how many results are returned by page

Returns:

(List[BoundDatacenter], Meta)

class BoundDatacenter(client: DatacentersClient, data: dict)[source]
model

alias of Datacenter

class Datacenter(id: int | None = None, name: str | None = None, description: str | None = None, location: Location | None = None, server_types: DatacenterServerTypes | None = None)[source]

Datacenter Domain

Parameters:

  • id – int ID of Datacenter

  • name – str Name of Datacenter

  • description – str Description of Datacenter

  • location – BoundLocation

  • server_types – DatacenterServerTypes

class DatacenterServerTypes(available: list[BoundServerType], supported: list[BoundServerType], available_for_migration: list[BoundServerType])[source]

DatacenterServerTypes Domain

Parameters:

  • available – List[BoundServerTypes] All available server types for this datacenter

  • supported – List[BoundServerTypes] All supported server types for this datacenter

  • available_for_migration – List[BoundServerTypes] All available for migration (change type) server types for this datacenter