Class API

constructor

• new API(client): AppleSilicon.v1alpha1.API

• Parameters

  • client: Client

  Returns AppleSilicon.v1alpha1.API

Static ReadonlyLOCALITIES

createServer

• createServer(request): Promise<AppleSilicon.v1alpha1.Server>

• Create a server. Create a new server in the targeted zone, specifying its configuration including name and type.

  Parameters

  • request: Readonly<AppleSilicon.v1alpha1.CreateServerRequest>

    The request CreateServerRequest

  Returns Promise<AppleSilicon.v1alpha1.Server>

  A Promise of Server

deleteServer

• deleteServer(request): Promise<void>

• Delete a server. Delete an existing Apple silicon server, specified by its server ID. Deleting a server is permanent, and cannot be undone. Note that the minimum allocation period for Apple silicon-as-a-service is 24 hours, meaning you cannot delete your server prior to that.

  Parameters

  • request: Readonly<AppleSilicon.v1alpha1.DeleteServerRequest>

    The request DeleteServerRequest

  Returns Promise<void>

getConnectivityDiagnostic

• getConnectivityDiagnostic(request): Promise<ConnectivityDiagnostic>

• Parameters

  • request: Readonly<GetConnectivityDiagnosticRequest>

  Returns Promise<ConnectivityDiagnostic>

getOS

• getOS(request): Promise<AppleSilicon.v1alpha1.OS>

• Get an Operating System (OS). Get an Operating System (OS). The response will include the OS's unique ID as well as its name and label.

  Parameters

  • request: Readonly<AppleSilicon.v1alpha1.GetOSRequest>

    The request GetOSRequest

  Returns Promise<AppleSilicon.v1alpha1.OS>

  A Promise of OS

getServer

• getServer(request): Promise<AppleSilicon.v1alpha1.Server>

• Get a server. Retrieve information about an existing Apple silicon server, specified by its server ID. Its full details, including name, status and IP address, are returned in the response object.

  Parameters

  • request: Readonly<AppleSilicon.v1alpha1.GetServerRequest>

    The request GetServerRequest

  Returns Promise<AppleSilicon.v1alpha1.Server>

  A Promise of Server

getServerType

• getServerType(request): Promise<AppleSilicon.v1alpha1.ServerType>

• Get a server type. Get technical details (CPU, disk size etc.) of a server type.

  Parameters

  • request: Readonly<GetServerTypeRequest>

    The request GetServerTypeRequest

  Returns Promise<AppleSilicon.v1alpha1.ServerType>

  A Promise of ServerType

listOS

• listOS(request?): Promise<AppleSilicon.v1alpha1.ListOSResponse> & {
      [asyncIterator]: (() => AsyncGenerator<AppleSilicon.v1alpha1.OS[], void, void>);
      all: (() => Promise<AppleSilicon.v1alpha1.OS[]>);
  }

• List all Operating Systems (OS). List all Operating Systems (OS). The response will include the total number of OS as well as their associated IDs, names and labels.

  Parameters

  • request: Readonly<AppleSilicon.v1alpha1.ListOSRequest> = {}

    The request ListOSRequest

  Returns Promise<AppleSilicon.v1alpha1.ListOSResponse> & {
      [asyncIterator]: (() => AsyncGenerator<AppleSilicon.v1alpha1.OS[], void, void>);
      all: (() => Promise<AppleSilicon.v1alpha1.OS[]>);
  }

  A Promise of ListOSResponse

listServerTypes

• listServerTypes(request?): Promise<ListServerTypesResponse>

• List server types. List all technical details about Apple silicon server types available in the specified zone. Since there is only one Availability Zone for Apple silicon servers, the targeted value is fr-par-3.

  Parameters

  • request: Readonly<ListServerTypesRequest> = {}

    The request ListServerTypesRequest

  Returns Promise<ListServerTypesResponse>

  A Promise of ListServerTypesResponse

listServers

• listServers(request?): Promise<AppleSilicon.v1alpha1.ListServersResponse> & {
      [asyncIterator]: (() => AsyncGenerator<AppleSilicon.v1alpha1.Server[], void, void>);
      all: (() => Promise<AppleSilicon.v1alpha1.Server[]>);
  }

• List all servers. List all servers in the specified zone. By default, returned servers in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.

  Parameters

  • request: Readonly<AppleSilicon.v1alpha1.ListServersRequest> = {}

    The request ListServersRequest

  Returns Promise<AppleSilicon.v1alpha1.ListServersResponse> & {
      [asyncIterator]: (() => AsyncGenerator<AppleSilicon.v1alpha1.Server[], void, void>);
      all: (() => Promise<AppleSilicon.v1alpha1.Server[]>);
  }

  A Promise of ListServersResponse

rebootServer

• rebootServer(request): Promise<AppleSilicon.v1alpha1.Server>

• Reboot a server. Reboot an existing Apple silicon server, specified by its server ID.

  Parameters

  • request: Readonly<AppleSilicon.v1alpha1.RebootServerRequest>

    The request RebootServerRequest

  Returns Promise<AppleSilicon.v1alpha1.Server>

  A Promise of Server

reinstallServer

• reinstallServer(request): Promise<AppleSilicon.v1alpha1.Server>

• Reinstall a server. Reinstall an existing Apple silicon server (specified by its server ID) from a new image (OS). All the data on the disk is deleted and all configuration is reset to the defailt configuration values of the image (OS).

  Parameters

  • request: Readonly<ReinstallServerRequest>

    The request ReinstallServerRequest

  Returns Promise<AppleSilicon.v1alpha1.Server>

  A Promise of Server

startConnectivityDiagnostic

• startConnectivityDiagnostic(request): Promise<StartConnectivityDiagnosticResponse>

• Parameters

  • request: Readonly<StartConnectivityDiagnosticRequest>

  Returns Promise<StartConnectivityDiagnosticResponse>

updateServer

• updateServer(request): Promise<AppleSilicon.v1alpha1.Server>

• Update a server. Update the parameters of an existing Apple silicon server, specified by its server ID.

  Parameters

  • request: Readonly<AppleSilicon.v1alpha1.UpdateServerRequest>

    The request UpdateServerRequest

  Returns Promise<AppleSilicon.v1alpha1.Server>

  A Promise of Server

waitForServer

• waitForServer(request, options?): Promise<AppleSilicon.v1alpha1.Server>

• Waits for Server to be in a final state.

  Parameters

  • request: Readonly<AppleSilicon.v1alpha1.GetServerRequest>

    The request GetServerRequest
  • Optionaloptions: Readonly<WaitForOptions<AppleSilicon.v1alpha1.Server>>

    The waiting options

  Returns Promise<AppleSilicon.v1alpha1.Server>

  A Promise of Server