Search Results for

    Show / Hide Table of Contents

    LS Retail Update Service

    AuditLogs

    GetAudits

    Request
    GET /api/v1/AuditLogs[?Page&PerPage&OrderBy&userName&operation]
    Parameters
    Name Type Value Notes
    Page integer
    PerPage integer
    OrderBy array
    userName string
    operation string
    Responses
    Status Code Description Samples
    200

    Success

    GetAuditLog

    Request
    GET /api/v1/AuditLogs/{id}
    Parameters
    Name Type Value Notes
    *id integer
    Responses
    Status Code Description Samples
    200

    Success

    GetAuditLogTypes

    Request
    GET /api/v1/AuditLogs/types
    Responses
    Status Code Description Samples
    200

    Success

    Auth

    GetGoogleSettings

    Request
    GET /api/v1/Auth/google/settings
    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    GoogleSignIn

    Request
    POST /api/v1/Auth/google
    Parameters
    Name Type Value Notes
    body
    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    GetMicrosoftSettings

    Request
    GET /api/v1/Auth/microsoft/settings
    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    MicrosoftSignIn

    Request
    POST /api/v1/Auth/microsoft
    Parameters
    Name Type Value Notes
    body
    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    ValidateLogin

    Request
    GET /api/v1/Auth/Validate
    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    Azure

    TestAzureStorageConnection

    Tests the Connection to the Azure Storage Settings.

    Request
    POST /api/v1/azure/storage/test
    Parameters
    Name Type Value Notes
    *body

    Test the connection with the credentials given.

    Responses
    Status Code Description Samples
    204

    No Content

    400

    Bad Request

    MigratePackageFilesToAzureStorage

    Migrate package files to Azure storage.

    Request
    POST /api/v1/azure/storage/migrate
    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    ClientCommands

    GetClientCommand

    Request
    GET /api/v1/ClientCommands[?guid]
    Parameters
    Name Type Value Notes
    guid string
    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    CreateClientCommand

    Request
    POST /api/v1/ClientCommands
    Parameters
    Name Type Value Notes
    body
    Responses
    Status Code Description Samples
    200

    Success

    Clients

    GetClients

    Gets information about clients registered on the server.

    Request
    GET /api/v1/Clients[?filter&packageId&Page&PerPage&OrderBy]
    Parameters
    Name Type Value Notes
    filter string

    Specifies the filter on hostname and GUID to return.

    packageId string

    Specifies the package ID to return only clients that have it previously installed.

    Page integer
    PerPage integer
    OrderBy array
    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    GetClient

    Gets information about specified client.

    Request
    GET /api/v1/Clients/{clientId}
    Parameters
    Name Type Value Notes
    *clientId integer

    Specifies the ID of the client return.

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    Files

    GetFile

    Gets information about specified file.

    Request
    GET /api/v1/Files/{hash}
    Parameters
    Name Type Value Notes
    *hash string

    Specifies the file SHA1 hash to return. (Value needs double URI encoding.)

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    GetStorage

    Gets information about the storage being used.

    Request
    GET /api/v1/Files/storage
    Responses
    Status Code Description Samples
    200

    Success

    GetExistingFile

    Get a list of hash codes and reply with the existing ones.

    Request
    POST /api/v1/Files/existing
    Parameters
    Name Type Value Notes
    body

    Specifies the hash codes of the files.

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    NewFiles

    Register files from azure storage to server.

    Request
    POST /api/v1/Files
    Parameters
    Name Type Value Notes
    body

    Specifies the azure files we want to save on the database.

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    DeleteFiles

    Regist files from azure storage to server.

    Request
    DELETE /api/v1/Files/DeleteFiles
    Responses
    Status Code Description Samples
    200

    Success

    Groups

    GetGroups

    Gets information about groups on server.

    Request
    GET /api/v1/Groups[?Page&PerPage&OrderBy&filter&scheduleId&clientId]
    Parameters
    Name Type Value Notes
    Page integer
    PerPage integer
    OrderBy array
    filter string

    Specifies filtering on name and description to return.

    scheduleId string

    Specifies the schedule to return.

    clientId integer

    Specifies the client to return.

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    NewGroup

    Creates a new group.

    Request
    POST /api/v1/Groups
    Parameters
    Name Type Value Notes
    body

    Specifies the group information to create.

    Responses
    Status Code Description Samples
    201

    Created

    400

    Bad Request

    GetClientsInGroups

    Gets clients in specified group.

    Request
    GET /api/clients[?Page&PerPage&OrderBy&groupIds&filter]
    Parameters
    Name Type Value Notes
    Page integer
    PerPage integer
    OrderBy array
    groupIds array

    Specifies the groups to return.

    filter string

    Specifies filtering on client/host name to return.

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    GetGroup

    Gets information about group by ID.

    Request
    GET /api/v1/Groups/{groupId}
    Parameters
    Name Type Value Notes
    *groupId string

    Specifies the ID of the group to return.

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    UpdateGroup

    Updates group information.

    Request
    PUT /api/v1/Groups/{groupId}
    Parameters
    Name Type Value Notes
    *groupId string

    Specifies the ID of the group to update.

    *body

    Specifies the group information to update.

    Responses
    Status Code Description Samples
    204

    No Content

    400

    Bad Request

    404

    Not Found

    RemoveGroup

    Removes group from server specified by ID.

    Request
    DELETE /api/v1/Groups/{groupId}
    Parameters
    Name Type Value Notes
    *groupId string

    Specifies the ID of the group to remove.

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    GetScheduleGroups

    Gets groups by schedule identifier

    Request
    GET /api/v1/Groups/schedule/{scheduleId}
    Parameters
    Name Type Value Notes
    *scheduleId string

    Specifies the ID of the schedule.

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    AddClientsToGroup

    Adds clients to a group.

    Request
    POST /api/v1/Groups/{groupId}/clients
    Parameters
    Name Type Value Notes
    *groupId string

    Specifies the ID of the group.

    body

    Specifies the IDs of the clients to add.

    Responses
    Status Code Description Samples
    200

    Success

    RemoveClientFromGroup

    Removes client from group from the server specified by ID.

    Request
    DELETE /api/v1/Groups/{groupId}/clients/{clientId}
    Parameters
    Name Type Value Notes
    *clientId string

    Specifies the ID of the client to remove.

    *groupId string

    Specifies the ID of the group to remove from.

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    Image

    GetImage

    Request
    GET /api/v1/Image[?uri&scaleWidth&scaleHeight&zoom&cropWidth&cropHeight&location]
    Parameters
    Name Type Value Notes
    uri string
    scaleWidth integer
    scaleHeight integer
    zoom integer
    cropWidth integer
    cropHeight integer
    location integer
    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    InstallInstructions

    NewInstallInstruction

    Creates a new install instruction on server.

    Request
    POST /api/v1/InstallInstructions
    Parameters
    Name Type Value Notes
    body

    Specifies the installer instruction information.

    Responses
    Status Code Description Samples
    201

    Created

    400

    Bad Request

    GetInstallInstructions

    Gets information about install instructions on server.

    Request
    GET /api/v1/InstallInstructions[?Page&PerPage&OrderBy&filter]
    Parameters
    Name Type Value Notes
    Page integer
    PerPage integer
    OrderBy array
    filter string

    Specifies filtering on name and description to return.

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    GetInstallInstruction

    Gets information about install instruction specified by ID.

    Request
    GET /api/v1/InstallInstructions/{installInstructionId}
    Parameters
    Name Type Value Notes
    *installInstructionId string

    Specifies the ID of the install instruction to return.

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    UpdateInstallInstruction

    Updates install instruction information.

    Request
    PUT /api/v1/InstallInstructions/{installInstructionId}
    Parameters
    Name Type Value Notes
    *installInstructionId string

    Specifies the ID of the install instruction to return.

    *body

    Specifies the installer instruction information to be updated.

    Responses
    Status Code Description Samples
    204

    No Content

    400

    Bad Request

    404

    Not Found

    RemoveInstallInstruction

    Removes install instruction from server specified by ID.

    Request
    DELETE /api/v1/InstallInstructions/{installInstructionId}
    Parameters
    Name Type Value Notes
    *installInstructionId string

    Specifies the ID of the install instruction to remove.

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    NewInstallInstructionStep

    Creates a new install instruction step on server.

    Request
    POST /api/v1/InstallInstructions/{installInstructionId}/steps[?atIndex]
    Parameters
    Name Type Value Notes
    *installInstructionId string

    Specifies the ID of the install instruction to associate.

    atIndex integer

    Specifies the position at which the new install instruction step should be inserted.

    *body

    Specifies the step information to create.

    Responses
    Status Code Description Samples
    201

    Created

    400

    Bad Request

    404

    Not Found

    GetInstallInstructionSteps

    Gets information about install instructions steps.

    Request
    GET /api/v1/InstallInstructions/{installInstructionId}/steps[?Page&PerPage&OrderBy]
    Parameters
    Name Type Value Notes
    Page integer
    PerPage integer
    OrderBy array
    *installInstructionId string

    Specifies the ID of the install instruction to return.

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    GetInstallInstructionStep

    Gets information about install instruction step.

    Request
    GET /api/v1/InstallInstructions/{installInstructionId}/steps/{installInstructionStepId}
    Parameters
    Name Type Value Notes
    *installInstructionId string

    Specifies the ID of the associated install instruction.

    *installInstructionStepId string

    Specifies the ID of the install instruction step to return.

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    UpdateInstallInstructionStep

    Updates install instruction step information.

    Request
    PUT /api/v1/InstallInstructions/{installInstructionId}/steps/{installInstructionStepId}
    Parameters
    Name Type Value Notes
    *installInstructionId string

    Specifies the ID of the associated install instruction.

    *installInstructionStepId string

    Specifies the ID of the install instruction step to update.

    body

    Specifies the install instruction step information to update.

    Responses
    Status Code Description Samples
    204

    No Content

    400

    Bad Request

    404

    Not Found

    RemoveInstallInstructionStep

    Removes step from install instruction.

    Request
    DELETE /api/v1/InstallInstructions/{installInstructionId}/steps/{installInstructionStepId}
    Parameters
    Name Type Value Notes
    *installInstructionStepId string

    Specifies the ID of the install instruction step to remove.

    *installInstructionId string

    Specifies the ID of the associated install instruction.

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    ReorderInstallInstructionSteps

    Reorders install instruction steps.

    Request
    POST /api/v1/InstallInstructions/{installInstructionId}/steps/order
    Parameters
    Name Type Value Notes
    *installInstructionId string

    Specifies the ID of the associated install instruction.

    *body

    Specifies new ID order list.

    Responses
    Status Code Description Samples
    204

    No Content

    GetListOfInstallInstructions

    Gets list of Install Instructions by install Instructions list of identifiers

    Request
    GET /api/v1/InstallInstructions/GetListOfInstallInstructions[?guids&excludeDetails]
    Parameters
    Name Type Value Notes
    guids array

    List of identifiers from install Instruction

    excludeDetails boolean

    exclude details

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    GetInstallInstructionStepArguments

    Gets information about install instruction step arguments specified by step ID.

    Request
    GET /api/v1/InstallInstructions/{installInstructionId}/steps/{installInstructionStepId}/arguments
    Parameters
    Name Type Value Notes
    *installInstructionId string

    Specifies the ID of the associated install instruction.

    *installInstructionStepId string

    Specifies the ID of the arguments step to return.

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    NewArgument

    New install instruction step argument.

    Request
    POST /api/v1/InstallInstructions/{installInstructionId}/steps/{installInstructionStepId}/argument/{key}
    Parameters
    Name Type Value Notes
    *installInstructionId string

    Specifies the ID of the associated install instruction.

    *installInstructionStepId string

    Specifies the ID of the associated step.

    *key string

    Specifies the key of the argument to create.

    *body

    Specifies the value of the argument.

    Responses
    Status Code Description Samples
    201

    Created

    400

    Bad Request

    404

    Not Found

    UpdateArgument

    Updates the install instruction step argument.

    Request
    PUT /api/v1/InstallInstructions/{installInstructionId}/steps/{installInstructionStepId}/argument/{key}
    Parameters
    Name Type Value Notes
    *installInstructionId string

    Specifies the ID of the associated install instruction.

    *installInstructionStepId string

    Specifies the ID of the associated step.

    *key string

    Specifies the key of the argument to update.

    *body

    Specifies the new value of the argument.

    Responses
    Status Code Description Samples
    204

    No Content

    400

    Bad Request

    404

    Not Found

    RemoveInstallInstructionStepArgument

    Removes install instruction step argument.

    Request
    DELETE /api/v1/InstallInstructions/{installInstructionId}/steps/{installInstructionStepId}/argument/{key}
    Parameters
    Name Type Value Notes
    *installInstructionId string

    Specifies the ID of the associated install instruction.

    *installInstructionStepId string

    Specifies the ID of the associated step.

    *key string

    Specifies the key of the argument to remove.

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    InstallScript

    GetInstallClient

    Download a PowerShell script to install client.

    Request
    GET /api/InstallScript
    Responses
    Status Code Description Samples
    200

    Success

    Installers

    GetInstallers

    Get information about installers on server.

    Request
    GET /api/v1/Installers[?excludeDetails&Page&PerPage&OrderBy&filter]
    Parameters
    Name Type Value Notes
    excludeDetails boolean

    Specifies if detailed information should be excluded.

    Page integer
    PerPage integer
    OrderBy array
    filter string

    Query filter for name and descriptions

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    NewInstaller

    Creates a new installer.

    Request
    POST /api/v1/Installers
    Parameters
    Name Type Value Notes
    *body

    Specifies the installer information.

    Responses
    Status Code Description Samples
    201

    Created

    400

    Bad Request

    GetInstaller

    Get information about installer specified by ID.

    Request
    GET /api/v1/Installers/{installerId}[?excludeDetails]
    Parameters
    Name Type Value Notes
    *installerId string

    Specifies the ID of the installer to return.

    excludeDetails boolean

    Specifies if detailed information should be excluded.

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    UpdateInstaller

    Updates installer information.

    Request
    PUT /api/v1/Installers/{installerId}
    Parameters
    Name Type Value Notes
    *installerId string

    Specifies the ID of the installer to update.

    *body

    Specifies the new installer information.

    Responses
    Status Code Description Samples
    204

    No Content

    400

    Bad Request

    404

    Not Found

    RemoveInstaller

    Removes installer from server specified by ID.

    Request
    DELETE /api/v1/Installers/{installerId}
    Parameters
    Name Type Value Notes
    *installerId string

    Specifies the ID of the installer to remove.

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    GetInstallerPackages

    Get all packages from specified installer.

    Request
    GET /api/v1/Installers/{installerId}/packages[?Page&PerPage&OrderBy]
    Parameters
    Name Type Value Notes
    *installerId string

    Specifies the ID of the installer to return.

    Page integer
    PerPage integer
    OrderBy array
    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    AddInstallerPackage

    Adds a package to specified installer.

    Request
    POST /api/v1/Installers/{installerId}/packages[?atIndex]
    Parameters
    Name Type Value Notes
    *installerId string

    Specifies the ID of the installer to add to.

    atIndex integer

    Specifies the index where the package should be added. If omitted, it will be added last.

    *body

    Specifies the package information.

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    RemoveInstallerPackages

    Removes packages from installer specified by their entry IDs.

    Request
    DELETE /api/v1/Installers/{installerId}/packages[?ids]
    Parameters
    Name Type Value Notes
    *installerId string

    Specifies the ID of the installer to remove from.

    ids array

    Specifies the IDs

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    GetInstallerInstructions

    Get all instructions from specified installer.

    Request
    GET /api/v1/Installers/{installerId}/instructions[?Page&PerPage&OrderBy]
    Parameters
    Name Type Value Notes
    *installerId string

    Specifies the ID of the installer to return.

    Page integer
    PerPage integer
    OrderBy array
    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    AddInstallerInstructions

    Adds a package to specified installer.

    Request
    POST /api/v1/Installers/{installerId}/instructions?installInstructionId[&atIndex]
    Parameters
    Name Type Value Notes
    *installerId string

    Specifies the ID of the installer to add to.

    *installInstructionId string

    Specifies the instruction ID

    atIndex integer

    Specifies the index where the package should be added. If omitted, it will be added last.

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    GetInstallerPackage

    Gets package information on installer specified by ID.

    Request
    GET /api/v1/Installers/{installerId}/packages/{installerPackageId}
    Parameters
    Name Type Value Notes
    *installerId string

    Specifies the ID of the installer to return.

    *installerPackageId integer

    Specifies the ID of the package entry to return.

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    UpdateInstallerPackage

    Updates the package information on an installer.

    Request
    PUT /api/v1/Installers/{installerId}/packages/{installerPackageId}[?newIndex]
    Parameters
    Name Type Value Notes
    *installerId string

    Specifies the ID of the installer.

    *installerPackageId integer

    Specifies the ID of the package entry to update.

    newIndex integer

    Specifies a new index order.

    *body

    Specifies the package information to update.

    Responses
    Status Code Description Samples
    204

    No Content

    400

    Bad Request

    404

    Not Found

    RemoveInstallerPackage

    Removes package entry from specified installer.

    Request
    DELETE /api/v1/Installers/{installerId}/packages/{installerPackageId}
    Parameters
    Name Type Value Notes
    *installerId string

    Specifies the ID of the installer to remove from.

    *installerPackageId integer

    Specifies the ID of the entry to remove.

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    UpdateInstallerPackagesOrder

    Reorders packages on a installer.

    Request
    PUT /api/v1/Installers/{installerId}/packages/order
    Parameters
    Name Type Value Notes
    *installerId string

    Specifies the ID of the installer.

    *body

    Specifies the IDs in new order. The list must contain all IDs that belong to the installer.

    Responses
    Status Code Description Samples
    204

    No Content

    400

    Bad Request

    404

    Not Found

    RemoveInstallerInstruction

    Removes package entry from specified installer.

    Request
    DELETE /api/v1/Installers/{installerId}/instruction/{installerInstructionId}
    Parameters
    Name Type Value Notes
    *installerId string

    Specifies the ID of the installer to remove from.

    *installerInstructionId integer

    Specifies the ID of the entry to remove.

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    GetInstallerFile

    Downloads installer file specified by ID.

    Request
    GET /api/v1/Installers/{installerId}/download[?debug]
    Parameters
    Name Type Value Notes
    *installerId string

    Specifies the ID of the installer to download.

    debug boolean

    Specifies if a debug version should be downloaded.

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    Installs

    GetInstallTelemetries

    Gets all install telemetry information.

    Request
    GET /api/v1/Installs[?excludeDetails&Page&PerPage&OrderBy&clientId&packageId&version&filterErrors&fromDate&toDate&userName&groupId]
    Parameters
    Name Type Value Notes
    excludeDetails boolean

    Specifies if detailed information should be excluded.

    Page integer
    PerPage integer
    OrderBy array
    clientId string

    Specifies the ID of a client to return.

    packageId string

    Specifies the ID of a package to return.

    version string

    Specifies the version of a package to return.

    filterErrors string

    Specifies to return only errors.

    fromDate string

    Specifies from date to return.

    toDate string

    Specifies to date to return.

    userName string

    Username to filter installs.

    groupId string

    Specifies the ID of a group to return.

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    SendInstallTelemetry

    Sends install telemetry information to server.

    Request
    POST /api/v1/Installs
    Parameters
    Name Type Value Notes
    *body

    Specifies the install telemetry information.

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    GetInstallTelemetry

    Gets a install telemetry specified by ID.

    Request
    GET /api/v1/Installs/{installId}[?excludeDetails]
    Parameters
    Name Type Value Notes
    *installId string

    Specifies the ID of the installation.

    excludeDetails boolean

    Specifies if detailed information should be excluded.

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    GetInstallTelemetryPackages

    Gets all packages information for install telemetry.

    Request
    GET /api/v1/Installs/{installId}/packages[?Page&PerPage&OrderBy]
    Parameters
    Name Type Value Notes
    *installId string

    Specifies the ID of the install telemetry to return.

    Page integer
    PerPage integer
    OrderBy array
    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    GetInstallTelemetryExecutions

    Gets all execution information for install telemetry.

    Request
    GET /api/v1/Installs/{installId}/executions[?Page&PerPage&OrderBy]
    Parameters
    Name Type Value Notes
    *installId string

    Specifies the ID of the install telemetry to return.

    Page integer
    PerPage integer
    OrderBy array
    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    ImportInstallTelemetry

    Sends install telemetry information to server.

    Request
    POST /api/v1/Installs/import
    Parameters
    Name Type Value Notes
    *body

    Specifies the install telemetry information.

    Responses
    Status Code Description Samples
    200

    Success

    Packages

    GetPackages

    Gets information about the packages on server.

    Request
    GET /api/v1/Packages[?Page&PerPage&OrderBy&filter]
    Parameters
    Name Type Value Notes
    Page integer
    PerPage integer
    OrderBy array
    filter string

    Specifies the filter on ID and name of a package to return.

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    NewPackage

    Imports package archive to the server.

    Request
    POST /api/v1/Packages[?overwrite]
    Parameters
    Name Type Value Notes
    overwrite boolean

    Specifies if it can overwrite existing version of package.

    body

    Specifies the manifest file to import and the files

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    GetPackageVersions

    Gets information about package versions specified by the ID of the package.

    Request
    GET /api/v1/Packages/{packageId}[?Page&PerPage&OrderBy&version&versionRange&versionQuery&includePreReleases]
    Parameters
    Name Type Value Notes
    *packageId string

    Specifies the ID of the package to return. (Value needs double URI encoding.)

    Page integer
    PerPage integer
    OrderBy array
    version string

    Specifies the version to return.

    versionRange string

    Specifies the version range to return.

    versionQuery string

    Specifies the version query to return.

    includePreReleases boolean

    Specifies to return pre-releases.

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    RemovePackageVersions

    Removes package version(s) by specified version.

    Request
    DELETE /api/v1/Packages/{packageId}[?version&versionRange&versionQuery&includePreReleases]
    Parameters
    Name Type Value Notes
    *packageId string

    Specifies the ID of the package to remove. (Value needs double URI encoding.)

    version string

    Specifies the version to remove

    versionRange string

    Specifies the version range to remove.

    versionQuery string

    Specifies the version query to remove.

    includePreReleases boolean

    Specifies include pre-releases to remove (only applicable with version range).

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    GetPackageVersion

    Gets information about package version.

    Request
    GET /api/v1/Packages/{packageId}/{version}
    Parameters
    Name Type Value Notes
    *packageId string

    Specifies the ID of a package to return. (Value needs double URI encoding.)

    *version string

    Specifies the version of a package to return.

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    GetPackageVersionFiles

    Gets information about files in package version.

    Request
    GET /api/v1/Packages/{packageId}/{version}/files[?Page&PerPage&OrderBy]
    Parameters
    Name Type Value Notes
    *packageId string

    Specifies the ID of a package to return. (Value needs double URI encoding.)

    *version string

    Specifies the version of a package to return.

    Page integer
    PerPage integer
    OrderBy array
    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    GetPackageFile

    Downloads a file in package version.

    Request
    GET /api/v1/Packages/{packageId}/{version}/files/{hash}[?inline]
    Parameters
    Name Type Value Notes
    *packageId string

    Specifies the ID of a package to download. (Value needs double URI encoding.)

    *version string

    Specifies the version of a package to download.

    *hash string

    Specifies the SHA1 hash of the file to download. (Value needs double URI encoding.)

    inline boolean

    Specifies if inline headers should be applied.

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    ImportPackage

    Imports package archive to the server.

    Request
    POST /api/v1/Packages/import[?overwrite]
    Parameters
    Name Type Value Notes
    overwrite boolean

    Specifies if it can overwrite existing version of package.

    *file file
    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    GetPackageFileUri

    Downloads a file in package version.

    Request
    GET /api/v1/Packages/{packageId}/{version}/files/uri/{hash}
    Parameters
    Name Type Value Notes
    *packageId string

    Specifies the ID of a package to download. (Value needs double URI encoding.)

    *version string

    Specifies the version of a package to download.

    *hash string

    Specifies the SHA1 hash of the file to download. (Value needs double URI encoding.)

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    GetPackageDependencies

    Gets information about package version.

    Request
    GET /api/v1/Packages/{packageId}/{version}/dependencies
    Parameters
    Name Type Value Notes
    *packageId string

    Specifies the ID of a package to return. (Value needs double URI encoding.)

    *version string

    Specifies the version of a package to return.

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    GetPackageParameters

    Gets information about package version.

    Request
    GET /api/v1/Packages/{packageId}/{version}/parameters
    Parameters
    Name Type Value Notes
    *packageId string

    Specifies the ID of a package to return. (Value needs double URI encoding.)

    *version string

    Specifies the version of a package to return.

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    PersonalTokens

    GetTokens

    Request
    GET /api/v1/PersonalTokens[?filter&Page&PerPage&OrderBy]
    Parameters
    Name Type Value Notes
    filter string
    Page integer
    PerPage integer
    OrderBy array
    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    NewToken

    Request
    POST /api/v1/PersonalTokens
    Parameters
    Name Type Value Notes
    body
    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    GetToken

    Request
    GET /api/v1/PersonalTokens/{tokenId}
    Parameters
    Name Type Value Notes
    *tokenId integer
    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    UpdateToken

    Request
    PUT /api/v1/PersonalTokens/{tokenId}
    Parameters
    Name Type Value Notes
    *tokenId integer
    body
    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    RevokeToken

    Request
    POST /api/v1/PersonalTokens/{tokenId}/revoke
    Parameters
    Name Type Value Notes
    *tokenId integer
    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    AuthenticateToken

    Request
    POST /api/v1/PersonalTokens/authenticate[?userName&personalToken]
    Parameters
    Name Type Value Notes
    userName string
    personalToken string
    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    Resolver

    ResolvePackageDependencies

    Resolves dependencies for specified list of packages.

    Request
    POST /api/v1/Packages/resolve[?excludeOptionalDependencies]
    Parameters
    Name Type Value Notes
    excludeOptionalDependencies boolean

    Specifies if optional dependencies should be excluded.

    *body

    Specifies the list of packages to resolve.

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    Schedules

    GetSchedules

    Gets information about schedules on server.

    Request
    GET /api/v1/Schedules[?Page&PerPage&OrderBy&filter]
    Parameters
    Name Type Value Notes
    Page integer
    PerPage integer
    OrderBy array
    filter string

    Specifies filtering on name and description to return.

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    NewSchedule

    Creates a new schedule.

    Request
    POST /api/v1/Schedules
    Parameters
    Name Type Value Notes
    *body

    Specifies the schedule information to create.

    Responses
    Status Code Description Samples
    201

    Created

    400

    Bad Request

    GetSchedule

    Gets information about schedule specified by ID.

    Request
    GET /api/v1/Schedules/{scheduleId}
    Parameters
    Name Type Value Notes
    *scheduleId string

    Specifies the ID of the schedule to return.

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    UpdateSchedule

    Updates schedule information.

    Request
    PUT /api/v1/Schedules/{scheduleId}
    Parameters
    Name Type Value Notes
    *scheduleId string

    Specifies the schedule ID to update.

    *body

    Specifies the schedule information to update.

    Responses
    Status Code Description Samples
    204

    No Content

    400

    Bad Request

    404

    Not Found

    RemoveSchedule

    Removes schedule from server specified by ID.

    Request
    DELETE /api/v1/Schedules/{scheduleId}
    Parameters
    Name Type Value Notes
    *scheduleId string

    Specifies the ID of the schedule to remove.

    Responses
    Status Code Description Samples
    400

    Bad Request

    GetScheduleWindows

    Gets information on schedule windows by schedule ID.

    Request
    GET /api/v1/Schedules/{scheduleId}/windows[?Page&PerPage&OrderBy]
    Parameters
    Name Type Value Notes
    Page integer
    PerPage integer
    OrderBy array
    *scheduleId string

    Specifies the ID of the schedule to return.

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    NewScheduleWindow

    Creates a new window on a schedule.

    Request
    POST /api/v1/Schedules/{scheduleId}/window
    Parameters
    Name Type Value Notes
    *scheduleId string

    Specifies the ID of the schedule to which the window will be added.

    body

    Specifies the schedule window information to create.

    Responses
    Status Code Description Samples
    201

    Created

    400

    Bad Request

    404

    Not Found

    UpdateScheduleWindow

    Updates schedule window information.

    Request
    PUT /api/v1/Schedules/{scheduleId}/window/{scheduleWindowId}
    Parameters
    Name Type Value Notes
    *scheduleId string

    Specifies the ID of the schedule which the window belongs.

    *scheduleWindowId integer

    Specifies the ID of the schedule windows to update.

    *body

    Specifies the schedule window information to update.

    Responses
    Status Code Description Samples
    204

    No Content

    400

    Bad Request

    404

    Not Found

    RemoveScheduleWindow

    Remove schedule window from server specified by ID.

    Request
    DELETE /api/v1/Schedules/{scheduleId}/window/{scheduleWindowId}
    Parameters
    Name Type Value Notes
    *scheduleId string

    Specifies the ID of the schedule which the window belongs.

    *scheduleWindowId integer

    Specifies the ID of the schedule window to remove.

    Responses
    Status Code Description Samples
    204

    No Content

    GetNextUpdateDateTime

    Gets next available update window for the client.

    Request
    POST /api/v1/Schedules/updateTime
    Parameters
    Name Type Value Notes
    body
    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    ServerToServer

    GetServerToServers

    Gets information about registered servers.

    Request
    GET /api/v1/ServerToServer[?Page&PerPage&OrderBy&url&filter]
    Parameters
    Name Type Value Notes
    Page integer
    PerPage integer
    OrderBy array
    url string

    Specifies the URL to return.

    filter string

    Specifies the URL to return.

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    NewServerToServer

    Creates new server.

    Request
    POST /api/v1/ServerToServer
    Parameters
    Name Type Value Notes
    body

    Specifies the server information.

    Responses
    Status Code Description Samples
    201

    Created

    400

    Bad Request

    GetServerToServer

    Gets information about registered server specified by ID.

    Request
    GET /api/v1/ServerToServer/{serverToServerId}
    Parameters
    Name Type Value Notes
    *serverToServerId integer

    Specifies the ID of the server to return.

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    UpdateServerToServer

    Updates specified server information.

    Request
    PUT /api/v1/ServerToServer/{serverToServerId}
    Parameters
    Name Type Value Notes
    *serverToServerId integer
    body

    Specifies the server information.

    Responses
    Status Code Description Samples
    204

    No Content

    400

    Bad Request

    404

    Not Found

    RemoveServerToServer

    Removes specified server.

    Request
    DELETE /api/v1/ServerToServer/{serverToServerId}
    Parameters
    Name Type Value Notes
    *serverToServerId integer

    Specifies the ID of the server.

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    GetServerToServerPackages

    Gets packages from specified server.

    Request
    GET /api/v1/ServerToServer/{serverToServerId}/packages
    Parameters
    Name Type Value Notes
    *serverToServerId integer

    Specifies the ID of the server.

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    ResolveServerToServerPackageDependencies

    Resolves dependencies for specified list of packages.

    Request
    POST /api/v1/ServerToServer/{serverToServerId}/packages/resolve[?excludeExisting&excludeOptionalDependencies]
    Parameters
    Name Type Value Notes
    *serverToServerId integer

    Specifies the ID of the server.

    excludeExisting boolean

    Specifies if existing packages should be excluded in the list.

    excludeOptionalDependencies boolean

    Specifies if optional dependencies should be excluded.

    *body

    Specifies a list of packages to resolve.

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    GetServerToServerPackagesVersions

    Gets versions of a package from specified remote server.

    Request
    POST /api/v1/ServerToServer/{serverToServerId}/packages/{packageId}/versions[?version&versionRange&versionQuery&includePreReleases]
    Parameters
    Name Type Value Notes
    *serverToServerId integer

    Specifies the ID of the server to return.

    *packageId string

    Specifies the ID of the package to return. (Value needs double URI encoding.)

    version string

    Specifies the version to return.

    versionRange string

    Specifies the version range to return.

    versionQuery string

    Specifies the version query to return.

    includePreReleases boolean

    Specifies to return pre-releases.

    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    StartDownloadServerToServerPackages

    Downloads specified packages from remote server.

    Request
    POST /api/v1/ServerToServer/{serverToServerId}/packages/download[?includeOptionalDependencies&wait]
    Parameters
    Name Type Value Notes
    *serverToServerId integer

    Specifies the ID of the server.

    includeOptionalDependencies boolean

    Specifies if optional dependencies should be downloaded.

    wait boolean

    Specifies if the call should wait until the packages are downloaded.

    *body

    Specifies the packages to download.

    Responses
    Status Code Description Samples
    200

    Success

    StartDownloadServerToServerInstaller

    Downloads specified installer from remote server.

    Request
    POST /api/v1/ServerToServer/{serverToServerId}/installers/{installerId}/download[?includeOptionalDependencies&wait]
    Parameters
    Name Type Value Notes
    *serverToServerId integer

    Specifies the ID of the server.

    *installerId string

    Specifies the ID of the installer to download.

    includeOptionalDependencies boolean

    Specifies if optional dependencies should be downloaded.

    wait boolean

    Specifies if the call should wait until the installer is downloaded.

    Responses
    Status Code Description Samples
    200

    Success

    Settings

    GetSettings

    Gets the server settings.

    Request
    GET /api/v1/Settings
    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    UpdateSettings

    Updates the server settings.

    Request
    PUT /api/v1/Settings
    Parameters
    Name Type Value Notes
    *body

    Specifies the settings information.

    Responses
    Status Code Description Samples
    204

    No Content

    400

    Bad Request

    TestDatabaseConnection

    Request
    POST /api/v1/Settings/database/test
    Parameters
    Name Type Value Notes
    body
    Responses
    Status Code Description Samples
    204

    No Content

    400

    Bad Request

    GetServerInfo

    Get server info

    Request
    GET /api/v1/Settings/server
    Responses
    Status Code Description Samples
    200

    Success

    GetServerDebug

    Creates a Debug file with relevant server information

    Request
    GET /api/v1/Settings/server/debug
    Responses
    Status Code Description Samples
    200

    Success

    GetApplicationInsightsInfo

    Get AppInsights Connection String

    Request
    GET /api/v1/Settings/applicationInsights
    Responses
    Status Code Description Samples
    200

    Success

    Tasks

    GetTasks

    Request
    GET /api/Tasks[?type&Page&PerPage&OrderBy]
    Parameters
    Name Type Value Notes
    type string
    Page integer
    PerPage integer
    OrderBy array
    Responses
    Status Code Description Samples
    200

    Success

    CancelTask

    Request
    POST /api/Tasks/{guid}/cancel
    Parameters
    Name Type Value Notes
    *guid string
    Responses
    Status Code Description Samples
    200

    Success

    DismissTask

    Request
    POST /api/Tasks/{guid}/dismiss
    Parameters
    Name Type Value Notes
    *guid string
    Responses
    Status Code Description Samples
    200

    Success

    DismissAllTasks

    Request
    POST /api/Tasks/dismissAll
    Responses
    Status Code Description Samples
    200

    Success

    GetTask

    Request
    GET /api/Tasks/{guid}
    Parameters
    Name Type Value Notes
    *guid string
    Responses
    Status Code Description Samples
    200

    Success

    Users

    GetUsers

    Request
    GET /api/v1/Users[?filter&Page&PerPage&OrderBy]
    Parameters
    Name Type Value Notes
    filter string
    Page integer
    PerPage integer
    OrderBy array
    Responses
    Status Code Description Samples
    200

    Success

    NewUser

    Request
    POST /api/v1/Users
    Parameters
    Name Type Value Notes
    *body
    Responses
    Status Code Description Samples
    201

    Created

    400

    Bad Request

    GetUser

    Request
    GET /api/v1/Users/{userId}
    Parameters
    Name Type Value Notes
    *userId string
    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    GetMe

    Request
    GET /api/v1/Users/me
    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    GetRoles

    Request
    GET /api/v1/Users/roles
    Responses
    Status Code Description Samples
    200

    Success

    GetUserRoles

    Request
    GET /api/v1/Users/{userId}/roles
    Parameters
    Name Type Value Notes
    *userId string
    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    GrantRole

    Request
    POST /api/v1/Users/{userId}/roles
    Parameters
    Name Type Value Notes
    *userId string
    *body
    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    RemoveFromRole

    Request
    DELETE /api/v1/Users/{userId}/roles/{name}
    Parameters
    Name Type Value Notes
    *userId string
    *name string
    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    SetUserEnabled

    Request
    PUT /api/v1/Users/{userId}/enabled
    Parameters
    Name Type Value Notes
    *userId string
    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    SetUserDisabled

    Request
    PUT /api/v1/Users/{userId}/disabled
    Parameters
    Name Type Value Notes
    *userId string
    Responses
    Status Code Description Samples
    200

    Success

    400

    Bad Request

    404

    Not Found

    In This Article
    Back to top Generated by DocFX