Type Alias Server

Type declaration

• createServer:function

  • createServer(serverData: ServerSkeleton): Promise<ServerSkeleton>

    Creates a server

    Parameters

    • serverData: ServerSkeleton

      server object

    Returns Promise<ServerSkeleton>

    a promise that resolves to a server object

• createServerExportTemplate:function

  • createServerExportTemplate(): ServerExportInterface

    Create an empty server export template

    Returns ServerExportInterface

    an empty server export template

• exportServer:function

  • exportServer(
        serverId: string,
        options: ServerExportOptions,
    ): Promise<ServerExportInterface>

    Export a single server by id. The response can be saved to file as is.

    Parameters

    • serverId: string

      Server id
    • options: ServerExportOptions

      Server export options

    Returns Promise<ServerExportInterface>

    Promise resolving to a ServerExportInterface object.

• exportServerByUrl:function

  • exportServerByUrl(
        serverUrl: string,
        options: ServerExportOptions,
    ): Promise<ServerExportInterface>

    Export a single server by url. The response can be saved to file as is.

    Parameters

    • serverUrl: string

      Server url
    • options: ServerExportOptions

      Server export options

    Returns Promise<ServerExportInterface>

    Promise resolving to a ServerExportInterface object.

• exportServers:function

  • exportServers(options: ServerExportOptions): Promise<ServerExportInterface>

    Export all servers. The response can be saved to file as is.

    Parameters

    • options: ServerExportOptions

      Server export options

    Returns Promise<ServerExportInterface>

    Promise resolving to a ServerExportInterface object.

• importFirstServer:function

  • importFirstServer(
        importData: ServerExportInterface,
        options: ServerImportOptions,
    ): Promise<ServerExportInterface>

    Imports the first server from the importData

    Parameters

    • importData: ServerExportInterface

      server import data
    • options: ServerImportOptions

      server import options

    Returns Promise<ServerExportInterface>

• importServers:function

  • importServers(
        importData: ServerExportInterface,
        options: ServerImportOptions,
        serverId?: string,
        serverUrl?: string,
    ): Promise<ServerExportInterface>

    Imports servers along with their properties

    Parameters

    • importData: ServerExportInterface

      server import data
    • options: ServerImportOptions

      server import options
    • OptionalserverId: string

      Optional server id. If supplied, only the server (and its properties) of that id is imported. Takes priority over serverUrl if both are provided.
    • OptionalserverUrl: string

      Optional server url. If supplied, only the server of that url is imported.

    Returns Promise<ServerExportInterface>

    a promise that resolves to a server export object

• readServer:function

  • readServer(serverId: string): Promise<ServerSkeleton>

    Read server by id

    Parameters

    • serverId: string

      Server id

    Returns Promise<ServerSkeleton>

    a promise that resolves to a server object

• readServerByUrl:function

  • readServerByUrl(serverUrl: string): Promise<ServerSkeleton>

    Read server by url

    Parameters

    • serverUrl: string

      Server url

    Returns Promise<ServerSkeleton>

    a promise that resolves to a server object

• readServers:function

  • readServers(): Promise<ServerSkeleton[]>

    Read all servers.

    Returns Promise<ServerSkeleton[]>

    a promise that resolves to an array of server objects