LS Retail Update Service

AuditLogs

GetAudits

Request

GET /api/v1/AuditLogs[?Page&PerPage&OrderBy&userName&operation]

Parameters

Name	Type	Default	Notes
Page
PerPage
OrderBy
userName
operation

Responses

Status Code	Type	Description	Samples
200	AuditLogDtoPaginated	Success

GetAuditLog

Request

GET /api/v1/AuditLogs/{id}

Parameters

Name	Type	Default	Notes
*id

Responses

Status Code	Type	Description	Samples
200	AuditLogDto	Success

GetAuditLogTypes

Request

GET /api/v1/AuditLogs/types

Responses

Status Code	Type	Description	Samples
200	array	Success

Auth

GetGoogleSettings

Request

GET /api/v1/Auth/google/settings

Responses

Status Code	Type	Description	Samples
200	GoogleSettingsDto	Success
400	array	Bad Request

GoogleSignIn

Request

POST /api/v1/Auth/google

Parameters

Name	Type	Default	Notes
body	TokenDto

Responses

Status Code	Type	Description	Samples
200	LoginDto	Success
400	array	Bad Request

GetMicrosoftSettings

Request

GET /api/v1/Auth/microsoft/settings

Responses

Status Code	Type	Description	Samples
200	MicrosoftSettingsDto	Success
400	array	Bad Request

MicrosoftSignIn

Request

POST /api/v1/Auth/microsoft

Parameters

Name	Type	Default	Notes
body	TokenDto

Responses

Status Code	Type	Description	Samples
200	LoginDto	Success
400	array	Bad Request

ValidateLogin

Request

GET /api/v1/Auth/Validate

Responses

Status Code	Type	Description	Samples
200	LoginDto	Success
400	array	Bad Request

Azure

TestAzureStorageConnection

Tests the Connection to the Azure Storage Settings.

Request

POST /api/v1/azure/storage/test

Parameters

Name	Type	Default	Notes
*body	ServerSettingsDto		Test the connection with the credentials given.

Responses

Status Code	Type	Description	Samples
204		No Content
400	ValidationProblemDetails	Bad Request

MigratePackageFilesToAzureStorage

Migrate package files to Azure storage.

Request

POST /api/v1/azure/storage/migrate

Responses

Status Code	Type	Description	Samples
200		Success
400	ProblemDetails	Bad Request

ClientCommands

GetClientCommand

Request

GET /api/v1/ClientCommands[?guid]

Parameters

Name	Type	Default	Notes
guid

Responses

Status Code	Type	Description	Samples
200	ClientCommandDto	Success
400	ValidationProblemDetails	Bad Request

CreateClientCommand

Request

POST /api/v1/ClientCommands

Parameters

Name	Type	Default	Notes
body	ClientCommandDto

Responses

Status Code	Type	Description	Samples
200	string	Success

Clients

GetClients

Gets information about clients registered on the server.

Request

GET /api/v1/Clients[?filter&packageId&Page&PerPage&OrderBy]

Parameters

Name	Type	Default	Notes
filter			Specifies the filter on hostname and GUID to return.
packageId			Specifies the package ID to return only clients that have it previously installed.
Page
PerPage
OrderBy

Responses

Status Code	Type	Description	Samples
200	ClientDtoPaginated	Success
400	ValidationProblemDetails	Bad Request

GetClient

Gets information about specified client.

Request

GET /api/v1/Clients/{clientId}

Parameters

Name	Type	Default	Notes
*clientId			Specifies the ID of the client return.

Responses

Status Code	Type	Description	Samples
200	ClientDto	Success
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

Files

GetFile

Gets information about specified file.

Request

GET /api/v1/Files/{hash}

Parameters

Name	Type	Default	Notes
*hash			Specifies the file SHA1 hash to return. (Value needs double URI encoding.)

Responses

Status Code	Type	Description	Samples
200	string	Success
400	ProblemDetails	Bad Request
404	ProblemDetails	Not Found

GetStorage

Gets information about the storage being used.

Request

GET /api/v1/Files/storage

Responses

Status Code	Type	Description	Samples
200	StorageSettingsDto	Success

GetExistingFile

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

Request

POST /api/v1/Files/existing

Parameters

Name	Type	Default	Notes
body	array		Specifies the hash codes of the files.

Responses

Status Code	Type	Description	Samples
200	array	Success
400	ProblemDetails	Bad Request
404	ProblemDetails	Not Found

NewFiles

Register files from azure storage to server.

Request

POST /api/v1/Files

Parameters

Name	Type	Default	Notes
body	FileDto[]		Specifies the azure files we want to save on the database.

Responses

Status Code	Type	Description	Samples
200	FileDto[]	Success
400	ProblemDetails	Bad Request

DeleteFiles

Regist files from azure storage to server.

Request

DELETE /api/v1/Files/DeleteFiles

Responses

Status Code	Type	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	Default	Notes
Page
PerPage
OrderBy
filter			Specifies filtering on name and description to return.
scheduleId			Specifies the schedule to return.
clientId			Specifies the client to return.

Responses

Status Code	Type	Description	Samples
200	GroupDtoPaginated	Success
400	ValidationProblemDetails	Bad Request

NewGroup

Creates a new group.

Request

POST /api/v1/Groups

Parameters

Name	Type	Default	Notes
body	GroupDto		Specifies the group information to create.

Responses

Status Code	Type	Description	Samples
201	GroupDto	Created
400	ValidationProblemDetails	Bad Request

GetClientsInGroups

Gets clients in specified group.

Request

GET /api/clients[?Page&PerPage&OrderBy&groupIds&filter]

Parameters

Name	Type	Default	Notes
Page
PerPage
OrderBy
groupIds			Specifies the groups to return.
filter			Specifies filtering on client/host name to return.

Responses

Status Code	Type	Description	Samples
200	ClientDtoPaginated	Success
400	ValidationProblemDetails	Bad Request

GetGroup

Gets information about group by ID.

Request

GET /api/v1/Groups/{groupId}

Parameters

Name	Type	Default	Notes
*groupId			Specifies the ID of the group to return.

Responses

Status Code	Type	Description	Samples
200	GroupDto	Success
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

UpdateGroup

Updates group information.

Request

PUT /api/v1/Groups/{groupId}

Parameters

Name	Type	Default	Notes
*groupId			Specifies the ID of the group to update.
*body	GroupDto		Specifies the group information to update.

Responses

Status Code	Type	Description	Samples
204		No Content
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

RemoveGroup

Removes group from server specified by ID.

Request

DELETE /api/v1/Groups/{groupId}

Parameters

Name	Type	Default	Notes
*groupId			Specifies the ID of the group to remove.

Responses

Status Code	Type	Description	Samples
200		Success
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

GetScheduleGroups

Gets groups by schedule identifier

Request

GET /api/v1/Groups/schedule/{scheduleId}

Parameters

Name	Type	Default	Notes
*scheduleId			Specifies the ID of the schedule.

Responses

Status Code	Type	Description	Samples
200	GroupDto[]	Success
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

AddClientsToGroup

Adds clients to a group.

Request

POST /api/v1/Groups/{groupId}/clients

Parameters

Name	Type	Default	Notes
*groupId			Specifies the ID of the group.
body	array		Specifies the IDs of the clients to add.

Responses

Status Code	Type	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	Default	Notes
*clientId			Specifies the ID of the client to remove.
*groupId			Specifies the ID of the group to remove from.

Responses

Status Code	Type	Description	Samples
200		Success
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

Image

GetImage

Request

GET /api/v1/Image[?uri&scaleWidth&scaleHeight&zoom&cropWidth&cropHeight&location]

Parameters

Name	Type	Default	Notes
uri
scaleWidth
scaleHeight
zoom
cropWidth
cropHeight
location

Responses

Status Code	Type	Description	Samples
200	string	Success
400	array	Bad Request

InstallInstructions

NewInstallInstruction

Creates a new install instruction on server.

Request

POST /api/v1/InstallInstructions

Parameters

Name	Type	Default	Notes
body	InstallInstructionDto		Specifies the installer instruction information.

Responses

Status Code	Type	Description	Samples
201	InstallInstructionDto	Created
400	ValidationProblemDetails	Bad Request

GetInstallInstructions

Gets information about install instructions on server.

Request

GET /api/v1/InstallInstructions[?Page&PerPage&OrderBy&filter]

Parameters

Name	Type	Default	Notes
Page
PerPage
OrderBy
filter			Specifies filtering on name and description to return.

Responses

Status Code	Type	Description	Samples
200	InstallInstructionDtoPaginated	Success
400	ValidationProblemDetails	Bad Request

GetInstallInstruction

Gets information about install instruction specified by ID.

Request

GET /api/v1/InstallInstructions/{installInstructionId}

Parameters

Name	Type	Default	Notes
*installInstructionId			Specifies the ID of the install instruction to return.

Responses

Status Code	Type	Description	Samples
200	InstallInstructionDto	Success
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

UpdateInstallInstruction

Updates install instruction information.

Request

PUT /api/v1/InstallInstructions/{installInstructionId}

Parameters

Name	Type	Default	Notes
*installInstructionId			Specifies the ID of the install instruction to return.
*body	InstallInstructionDto		Specifies the installer instruction information to be updated.

Responses

Status Code	Type	Description	Samples
204		No Content
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

RemoveInstallInstruction

Removes install instruction from server specified by ID.

Request

DELETE /api/v1/InstallInstructions/{installInstructionId}

Parameters

Name	Type	Default	Notes
*installInstructionId			Specifies the ID of the install instruction to remove.

Responses

Status Code	Type	Description	Samples
200		Success
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

NewInstallInstructionStep

Creates a new install instruction step on server.

Request

POST /api/v1/InstallInstructions/{installInstructionId}/steps[?atIndex]

Parameters

Name	Type	Default	Notes
*installInstructionId			Specifies the ID of the install instruction to associate.
atIndex			Specifies the position at which the new install instruction step should be inserted.
*body	InstallInstructionStepDto		Specifies the step information to create.

Responses

Status Code	Type	Description	Samples
201	InstallInstructionStepDto	Created
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

GetInstallInstructionSteps

Gets information about install instructions steps.

Request

GET /api/v1/InstallInstructions/{installInstructionId}/steps[?Page&PerPage&OrderBy]

Parameters

Name	Type	Default	Notes
Page
PerPage
OrderBy
*installInstructionId			Specifies the ID of the install instruction to return.

Responses

Status Code	Type	Description	Samples
200	InstallInstructionStepDtoPaginated	Success
400	ValidationProblemDetails	Bad Request

GetInstallInstructionStep

Gets information about install instruction step.

Request

GET /api/v1/InstallInstructions/{installInstructionId}/steps/{installInstructionStepId}

Parameters

Name	Type	Default	Notes
*installInstructionId			Specifies the ID of the associated install instruction.
*installInstructionStepId			Specifies the ID of the install instruction step to return.

Responses

Status Code	Type	Description	Samples
200	InstallInstructionStepDto	Success
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

UpdateInstallInstructionStep

Updates install instruction step information.

Request

PUT /api/v1/InstallInstructions/{installInstructionId}/steps/{installInstructionStepId}

Parameters

Name	Type	Default	Notes
*installInstructionId			Specifies the ID of the associated install instruction.
*installInstructionStepId			Specifies the ID of the install instruction step to update.
body	InstallInstructionStepDto		Specifies the install instruction step information to update.

Responses

Status Code	Type	Description	Samples
204		No Content
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

RemoveInstallInstructionStep

Removes step from install instruction.

Request

DELETE /api/v1/InstallInstructions/{installInstructionId}/steps/{installInstructionStepId}

Parameters

Name	Type	Default	Notes
*installInstructionStepId			Specifies the ID of the install instruction step to remove.
*installInstructionId			Specifies the ID of the associated install instruction.

Responses

Status Code	Type	Description	Samples
200		Success
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

ReorderInstallInstructionSteps

Reorders install instruction steps.

Request

POST /api/v1/InstallInstructions/{installInstructionId}/steps/order

Parameters

Name	Type	Default	Notes
*installInstructionId			Specifies the ID of the associated install instruction.
*body	array		Specifies new ID order list.

Responses

Status Code	Type	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	Default	Notes
guids			List of identifiers from install Instruction
excludeDetails			exclude details

Responses

Status Code	Type	Description	Samples
200	InstallInstructionDto[]	Success
400	ValidationProblemDetails	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	Default	Notes
*installInstructionId			Specifies the ID of the associated install instruction.
*installInstructionStepId			Specifies the ID of the arguments step to return.

Responses

Status Code	Type	Description	Samples
200	PackageParameterDto	Success
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

NewArgument

New install instruction step argument.

Request

POST /api/v1/InstallInstructions/{installInstructionId}/steps/{installInstructionStepId}/argument/{key}

Parameters

Name	Type	Default	Notes
*installInstructionId			Specifies the ID of the associated install instruction.
*installInstructionStepId			Specifies the ID of the associated step.
*key			Specifies the key of the argument to create.
*body	string		Specifies the value of the argument.

Responses

Status Code	Type	Description	Samples
201	InstallInstructionStepArgumentDto	Created
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

UpdateArgument

Updates the install instruction step argument.

Request

PUT /api/v1/InstallInstructions/{installInstructionId}/steps/{installInstructionStepId}/argument/{key}

Parameters

Name	Type	Default	Notes
*installInstructionId			Specifies the ID of the associated install instruction.
*installInstructionStepId			Specifies the ID of the associated step.
*key			Specifies the key of the argument to update.
*body	string		Specifies the new value of the argument.

Responses

Status Code	Type	Description	Samples
204		No Content
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

RemoveInstallInstructionStepArgument

Removes install instruction step argument.

Request

DELETE /api/v1/InstallInstructions/{installInstructionId}/steps/{installInstructionStepId}/argument/{key}

Parameters

Name	Type	Default	Notes
*installInstructionId			Specifies the ID of the associated install instruction.
*installInstructionStepId			Specifies the ID of the associated step.
*key			Specifies the key of the argument to remove.

Responses

Status Code	Type	Description	Samples
200		Success
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

InstallScript

GetInstallClient

Download a PowerShell script to install client.

Request

GET /api/InstallScript

Responses

Status Code	Type	Description	Samples
200	string	Success

Installers

GetInstallers

Get information about installers on server.

Request

GET /api/v1/Installers[?excludeDetails&Page&PerPage&OrderBy&filter]

Parameters

Name	Type	Default	Notes
excludeDetails			Specifies if detailed information should be excluded.
Page
PerPage
OrderBy
filter			Query filter for name and descriptions

Responses

Status Code	Type	Description	Samples
200	InstallerDtoPaginated	Success
400	ValidationProblemDetails	Bad Request

NewInstaller

Creates a new installer.

Request

POST /api/v1/Installers

Parameters

Name	Type	Default	Notes
*body	InstallerDto		Specifies the installer information.

Responses

Status Code	Type	Description	Samples
201	InstallerDto	Created
400	ValidationProblemDetails	Bad Request

GetInstaller

Get information about installer specified by ID.

Request

GET /api/v1/Installers/{installerId}[?excludeDetails]

Parameters

Name	Type	Default	Notes
*installerId			Specifies the ID of the installer to return.
excludeDetails			Specifies if detailed information should be excluded.

Responses

Status Code	Type	Description	Samples
200	InstallerDto	Success
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

UpdateInstaller

Updates installer information.

Request

PUT /api/v1/Installers/{installerId}

Parameters

Name	Type	Default	Notes
*installerId			Specifies the ID of the installer to update.
*body	InstallerDto		Specifies the new installer information.

Responses

Status Code	Type	Description	Samples
204		No Content
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

RemoveInstaller

Removes installer from server specified by ID.

Request

DELETE /api/v1/Installers/{installerId}

Parameters

Name	Type	Default	Notes
*installerId			Specifies the ID of the installer to remove.

Responses

Status Code	Type	Description	Samples
200		Success
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

GetInstallerPackages

Get all packages from specified installer.

Request

GET /api/v1/Installers/{installerId}/packages[?Page&PerPage&OrderBy]

Parameters

Name	Type	Default	Notes
*installerId			Specifies the ID of the installer to return.
Page
PerPage
OrderBy

Responses

Status Code	Type	Description	Samples
200	InstallerPackageDtoPaginated	Success
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

AddInstallerPackage

Adds a package to specified installer.

Request

POST /api/v1/Installers/{installerId}/packages[?atIndex]

Parameters

Name	Type	Default	Notes
*installerId			Specifies the ID of the installer to add to.
atIndex			Specifies the index where the package should be added. If omitted, it will be added last.
*body	InstallerPackageDto		Specifies the package information.

Responses

Status Code	Type	Description	Samples
200	InstallerPackageDto	Success
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

RemoveInstallerPackages

Removes packages from installer specified by their entry IDs.

Request

DELETE /api/v1/Installers/{installerId}/packages[?ids]

Parameters

Name	Type	Default	Notes
*installerId			Specifies the ID of the installer to remove from.
ids			Specifies the IDs

Responses

Status Code	Type	Description	Samples
200		Success
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

GetInstallerInstructions

Get all instructions from specified installer.

Request

GET /api/v1/Installers/{installerId}/instructions[?Page&PerPage&OrderBy]

Parameters

Name	Type	Default	Notes
*installerId			Specifies the ID of the installer to return.
Page
PerPage
OrderBy

Responses

Status Code	Type	Description	Samples
200	InstallerInstructionDtoPaginated	Success
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

AddInstallerInstructions

Adds a package to specified installer.

Request

POST /api/v1/Installers/{installerId}/instructions?installInstructionId[&atIndex]

Parameters

Name	Type	Default	Notes
*installerId			Specifies the ID of the installer to add to.
*installInstructionId			Specifies the instruction ID
atIndex			Specifies the index where the package should be added. If omitted, it will be added last.

Responses

Status Code	Type	Description	Samples
200	InstallerInstructionDto	Success
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

GetInstallerPackage

Gets package information on installer specified by ID.

Request

GET /api/v1/Installers/{installerId}/packages/{installerPackageId}

Parameters

Name	Type	Default	Notes
*installerId			Specifies the ID of the installer to return.
*installerPackageId			Specifies the ID of the package entry to return.

Responses

Status Code	Type	Description	Samples
200	InstallerPackageDto	Success
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

UpdateInstallerPackage

Updates the package information on an installer.

Request

PUT /api/v1/Installers/{installerId}/packages/{installerPackageId}[?newIndex]

Parameters

Name	Type	Default	Notes
*installerId			Specifies the ID of the installer.
*installerPackageId			Specifies the ID of the package entry to update.
newIndex			Specifies a new index order.
*body	InstallerPackageDto		Specifies the package information to update.

Responses

Status Code	Type	Description	Samples
204		No Content
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

RemoveInstallerPackage

Removes package entry from specified installer.

Request

DELETE /api/v1/Installers/{installerId}/packages/{installerPackageId}

Parameters

Name	Type	Default	Notes
*installerId			Specifies the ID of the installer to remove from.
*installerPackageId			Specifies the ID of the entry to remove.

Responses

Status Code	Type	Description	Samples
200		Success
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

UpdateInstallerPackagesOrder

Reorders packages on a installer.

Request

PUT /api/v1/Installers/{installerId}/packages/order

Parameters

Name	Type	Default	Notes
*installerId			Specifies the ID of the installer.
*body	array		Specifies the IDs in new order. The list must contain all IDs that belong to the installer.

Responses

Status Code	Type	Description	Samples
204		No Content
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

RemoveInstallerInstruction

Removes package entry from specified installer.

Request

DELETE /api/v1/Installers/{installerId}/instruction/{installerInstructionId}

Parameters

Name	Type	Default	Notes
*installerId			Specifies the ID of the installer to remove from.
*installerInstructionId			Specifies the ID of the entry to remove.

Responses

Status Code	Type	Description	Samples
200		Success
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

GetInstallerFile

Downloads installer file specified by ID.

Request

GET /api/v1/Installers/{installerId}/download[?debug]

Parameters

Name	Type	Default	Notes
*installerId			Specifies the ID of the installer to download.
debug			Specifies if a debug version should be downloaded.

Responses

Status Code	Type	Description	Samples
200	string	Success
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	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	Default	Notes
excludeDetails			Specifies if detailed information should be excluded.
Page
PerPage
OrderBy
clientId			Specifies the ID of a client to return.
packageId			Specifies the ID of a package to return.
version			Specifies the version of a package to return.
filterErrors			Specifies to return only errors.
fromDate			Specifies from date to return.
toDate			Specifies to date to return.
userName			Username to filter installs.
groupId			Specifies the ID of a group to return.

Responses

Status Code	Type	Description	Samples
200	InstallTelemetryDtoPaginated	Success
400	ValidationProblemDetails	Bad Request

SendInstallTelemetry

Sends install telemetry information to server.

Request

POST /api/v1/Installs

Parameters

Name	Type	Default	Notes
*body	InstallTelemetryDto		Specifies the install telemetry information.

Responses

Status Code	Type	Description	Samples
200		Success
400	ValidationProblemDetails	Bad Request

GetInstallTelemetry

Gets a install telemetry specified by ID.

Request

GET /api/v1/Installs/{installId}[?excludeDetails]

Parameters

Name	Type	Default	Notes
*installId			Specifies the ID of the installation.
excludeDetails			Specifies if detailed information should be excluded.

Responses

Status Code	Type	Description	Samples
200	InstallTelemetryDto	Success
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

GetInstallTelemetryPackages

Gets all packages information for install telemetry.

Request

GET /api/v1/Installs/{installId}/packages[?Page&PerPage&OrderBy]

Parameters

Name	Type	Default	Notes
*installId			Specifies the ID of the install telemetry to return.
Page
PerPage
OrderBy

Responses

Status Code	Type	Description	Samples
200	InstallTelemetryPackageDtoPaginated	Success
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

GetInstallTelemetryExecutions

Gets all execution information for install telemetry.

Request

GET /api/v1/Installs/{installId}/executions[?Page&PerPage&OrderBy]

Parameters

Name	Type	Default	Notes
*installId			Specifies the ID of the install telemetry to return.
Page
PerPage
OrderBy

Responses

Status Code	Type	Description	Samples
200	InstallTelemetryExecutionDtoPaginated	Success
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

ImportInstallTelemetry

Sends install telemetry information to server.

Request

POST /api/v1/Installs/import

Parameters

Name	Type	Default	Notes
*body	InstallTelemetryDto		Specifies the install telemetry information.

Responses

Status Code	Type	Description	Samples
200	InstallTelemetryDto	Success

Packages

GetPackages

Gets information about the packages on server.

Request

GET /api/v1/Packages[?Page&PerPage&OrderBy&filter]

Parameters

Name	Type	Default	Notes
Page
PerPage
OrderBy
filter			Specifies the filter on ID and name of a package to return.

Responses

Status Code	Type	Description	Samples
200	PackageDtoPaginated	Success
400	ValidationProblemDetails	Bad Request

NewPackage

Imports package archive to the server.

Request

POST /api/v1/Packages[?overwrite]

Parameters

Name	Type	Default	Notes
overwrite			Specifies if it can overwrite existing version of package.
body	PackageManifestDto		Specifies the manifest file to import and the files

Responses

Status Code	Type	Description	Samples
200		Success
400	ProblemDetails	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	Default	Notes
*packageId			Specifies the ID of the package to return. (Value needs double URI encoding.)
Page
PerPage
OrderBy
version			Specifies the version to return.
versionRange			Specifies the version range to return.
versionQuery			Specifies the version query to return.
includePreReleases			Specifies to return pre-releases.

Responses

Status Code	Type	Description	Samples
200	PackageVersionDtoPaginated	Success
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

RemovePackageVersions

Removes package version(s) by specified version.

Request

DELETE /api/v1/Packages/{packageId}[?version&versionRange&versionQuery&includePreReleases]

Parameters

Name	Type	Default	Notes
*packageId			Specifies the ID of the package to remove. (Value needs double URI encoding.)
version			Specifies the version to remove
versionRange			Specifies the version range to remove.
versionQuery			Specifies the version query to remove.
includePreReleases			Specifies include pre-releases to remove (only applicable with version range).

Responses

Status Code	Type	Description	Samples
200		Success
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

GetPackageVersion

Gets information about package version.

Request

GET /api/v1/Packages/{packageId}/{version}

Parameters

Name	Type	Default	Notes
*packageId			Specifies the ID of a package to return. (Value needs double URI encoding.)
*version			Specifies the version of a package to return.

Responses

Status Code	Type	Description	Samples
200	PackageVersionDto	Success
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

GetPackageVersionFiles

Gets information about files in package version.

Request

GET /api/v1/Packages/{packageId}/{version}/files[?Page&PerPage&OrderBy]

Parameters

Name	Type	Default	Notes
*packageId			Specifies the ID of a package to return. (Value needs double URI encoding.)
*version			Specifies the version of a package to return.
Page
PerPage
OrderBy

Responses

Status Code	Type	Description	Samples
200	PackageVersionFileDtoPaginated	Success
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

GetPackageFile

Downloads a file in package version.

Request

GET /api/v1/Packages/{packageId}/{version}/files/{hash}[?inline]

Parameters

Name	Type	Default	Notes
*packageId			Specifies the ID of a package to download. (Value needs double URI encoding.)
*version			Specifies the version of a package to download.
*hash			Specifies the SHA1 hash of the file to download. (Value needs double URI encoding.)
inline			Specifies if inline headers should be applied.

Responses

Status Code	Type	Description	Samples
200	string	Success
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

ImportPackage

Imports package archive to the server.

Request

POST /api/v1/Packages/import[?overwrite]

Parameters

Name	Type	Default	Notes
overwrite			Specifies if it can overwrite existing version of package.
*file

Responses

Status Code	Type	Description	Samples
200	PackageVersionDto	Success
400	ProblemDetails	Bad Request

GetPackageFileUri

Downloads a file in package version.

Request

GET /api/v1/Packages/{packageId}/{version}/files/uri/{hash}

Parameters

Name	Type	Default	Notes
*packageId			Specifies the ID of a package to download. (Value needs double URI encoding.)
*version			Specifies the version of a package to download.
*hash			Specifies the SHA1 hash of the file to download. (Value needs double URI encoding.)

Responses

Status Code	Type	Description	Samples
200	string	Success
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

GetPackageDependencies

Gets information about package version.

Request

GET /api/v1/Packages/{packageId}/{version}/dependencies

Parameters

Name	Type	Default	Notes
*packageId			Specifies the ID of a package to return. (Value needs double URI encoding.)
*version			Specifies the version of a package to return.

Responses

Status Code	Type	Description	Samples
200	PackageDependencyDto	Success
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

GetPackageParameters

Gets information about package version.

Request

GET /api/v1/Packages/{packageId}/{version}/parameters

Parameters

Name	Type	Default	Notes
*packageId			Specifies the ID of a package to return. (Value needs double URI encoding.)
*version			Specifies the version of a package to return.

Responses

Status Code	Type	Description	Samples
200	PackageParameterDto	Success
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

PersonalTokens

GetTokens

Request

GET /api/v1/PersonalTokens[?filter&Page&PerPage&OrderBy]

Parameters

Name	Type	Default	Notes
filter
Page
PerPage
OrderBy

Responses

Status Code	Type	Description	Samples
200	PersonalTokenDtoPaginated	Success
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

NewToken

Request

POST /api/v1/PersonalTokens

Parameters

Name	Type	Default	Notes
body	PersonalTokenDto

Responses

Status Code	Type	Description	Samples
200	string	Success
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

GetToken

Request

GET /api/v1/PersonalTokens/{tokenId}

Parameters

Name	Type	Default	Notes
*tokenId

Responses

Status Code	Type	Description	Samples
200	PersonalTokenDto	Success
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

UpdateToken

Request

PUT /api/v1/PersonalTokens/{tokenId}

Parameters

Name	Type	Default	Notes
*tokenId
body	PersonalTokenDto

Responses

Status Code	Type	Description	Samples
200	string	Success
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

RevokeToken

Request

POST /api/v1/PersonalTokens/{tokenId}/revoke

Parameters

Name	Type	Default	Notes
*tokenId

Responses

Status Code	Type	Description	Samples
200	string	Success
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

AuthenticateToken

Request

POST /api/v1/PersonalTokens/authenticate[?userName&personalToken]

Parameters

Name	Type	Default	Notes
userName
personalToken

Responses

Status Code	Type	Description	Samples
200	LoginDto	Success
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

Resolver

ResolvePackageDependencies

Resolves dependencies for specified list of packages.

Request

POST /api/v1/Packages/resolve[?excludeOptionalDependencies]

Parameters

Name	Type	Default	Notes
excludeOptionalDependencies			Specifies if optional dependencies should be excluded.
*body	ResolveDependenciesRequest		Specifies the list of packages to resolve.

Responses

Status Code	Type	Description	Samples
200	ResolverPackageVersionDto[]	Success
400	ProblemDetails	Bad Request

Schedules

GetSchedules

Gets information about schedules on server.

Request

GET /api/v1/Schedules[?Page&PerPage&OrderBy&filter]

Parameters

Name	Type	Default	Notes
Page
PerPage
OrderBy
filter			Specifies filtering on name and description to return.

Responses

Status Code	Type	Description	Samples
200	ScheduleDtoPaginated	Success
400	ValidationProblemDetails	Bad Request

NewSchedule

Creates a new schedule.

Request

POST /api/v1/Schedules

Parameters

Name	Type	Default	Notes
*body	ScheduleDto		Specifies the schedule information to create.

Responses

Status Code	Type	Description	Samples
201	ScheduleDto	Created
400	ValidationProblemDetails	Bad Request

GetSchedule

Gets information about schedule specified by ID.

Request

GET /api/v1/Schedules/{scheduleId}

Parameters

Name	Type	Default	Notes
*scheduleId			Specifies the ID of the schedule to return.

Responses

Status Code	Type	Description	Samples
200	ScheduleDto	Success
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

UpdateSchedule

Updates schedule information.

Request

PUT /api/v1/Schedules/{scheduleId}

Parameters

Name	Type	Default	Notes
*scheduleId			Specifies the schedule ID to update.
*body	ScheduleDto		Specifies the schedule information to update.

Responses

Status Code	Type	Description	Samples
204		No Content
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

RemoveSchedule

Removes schedule from server specified by ID.

Request

DELETE /api/v1/Schedules/{scheduleId}

Parameters

Name	Type	Default	Notes
*scheduleId			Specifies the ID of the schedule to remove.

Responses

Status Code	Type	Description	Samples
400	ValidationProblemDetails	Bad Request

GetScheduleWindows

Gets information on schedule windows by schedule ID.

Request

GET /api/v1/Schedules/{scheduleId}/windows[?Page&PerPage&OrderBy]

Parameters

Name	Type	Default	Notes
Page
PerPage
OrderBy
*scheduleId			Specifies the ID of the schedule to return.

Responses

Status Code	Type	Description	Samples
200	ScheduleWindowDtoICollectionPaginated	Success
400	ValidationProblemDetails	Bad Request

NewScheduleWindow

Creates a new window on a schedule.

Request

POST /api/v1/Schedules/{scheduleId}/window

Parameters

Name	Type	Default	Notes
*scheduleId			Specifies the ID of the schedule to which the window will be added.
body	ScheduleWindowDto		Specifies the schedule window information to create.

Responses

Status Code	Type	Description	Samples
201	ScheduleWindowDto	Created
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

UpdateScheduleWindow

Updates schedule window information.

Request

PUT /api/v1/Schedules/{scheduleId}/window/{scheduleWindowId}

Parameters

Name	Type	Default	Notes
*scheduleId			Specifies the ID of the schedule which the window belongs.
*scheduleWindowId			Specifies the ID of the schedule windows to update.
*body	ScheduleWindowDto		Specifies the schedule window information to update.

Responses

Status Code	Type	Description	Samples
204		No Content
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

RemoveScheduleWindow

Remove schedule window from server specified by ID.

Request

DELETE /api/v1/Schedules/{scheduleId}/window/{scheduleWindowId}

Parameters

Name	Type	Default	Notes
*scheduleId			Specifies the ID of the schedule which the window belongs.
*scheduleWindowId			Specifies the ID of the schedule window to remove.

Responses

Status Code	Type	Description	Samples
204		No Content

GetNextUpdateDateTime

Gets next available update window for the client.

Request

POST /api/v1/Schedules/updateTime

Parameters

Name	Type	Default	Notes
body	ScheduleNextUpdateDto

Responses

Status Code	Type	Description	Samples
200	string	Success
400	ValidationProblemDetails	Bad Request

ServerToServer

GetServerToServers

Gets information about registered servers.

Request

GET /api/v1/ServerToServer[?Page&PerPage&OrderBy&url&filter]

Parameters

Name	Type	Default	Notes
Page
PerPage
OrderBy
url			Specifies the URL to return.
filter			Specifies the URL to return.

Responses

Status Code	Type	Description	Samples
200	ServerToServerDtoPaginated	Success
400	ValidationProblemDetails	Bad Request

NewServerToServer

Creates new server.

Request

POST /api/v1/ServerToServer

Parameters

Name	Type	Default	Notes
body	ServerToServerDto		Specifies the server information.

Responses

Status Code	Type	Description	Samples
201	ServerToServerDto	Created
400	ValidationProblemDetails	Bad Request

GetServerToServer

Gets information about registered server specified by ID.

Request

GET /api/v1/ServerToServer/{serverToServerId}

Parameters

Name	Type	Default	Notes
*serverToServerId			Specifies the ID of the server to return.

Responses

Status Code	Type	Description	Samples
200	ServerToServerDto	Success
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

UpdateServerToServer

Updates specified server information.

Request

PUT /api/v1/ServerToServer/{serverToServerId}

Parameters

Name	Type	Default	Notes
*serverToServerId
body	ServerToServerDto		Specifies the server information.

Responses

Status Code	Type	Description	Samples
204		No Content
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

RemoveServerToServer

Removes specified server.

Request

DELETE /api/v1/ServerToServer/{serverToServerId}

Parameters

Name	Type	Default	Notes
*serverToServerId			Specifies the ID of the server.

Responses

Status Code	Type	Description	Samples
200		Success
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

GetServerToServerPackages

Gets packages from specified server.

Request

GET /api/v1/ServerToServer/{serverToServerId}/packages

Parameters

Name	Type	Default	Notes
*serverToServerId			Specifies the ID of the server.

Responses

Status Code	Type	Description	Samples
200	PackageDto[]	Success
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

ResolveServerToServerPackageDependencies

Resolves dependencies for specified list of packages.

Request

POST /api/v1/ServerToServer/{serverToServerId}/packages/resolve[?excludeExisting&excludeOptionalDependencies]

Parameters

Name	Type	Default	Notes
*serverToServerId			Specifies the ID of the server.
excludeExisting			Specifies if existing packages should be excluded in the list.
excludeOptionalDependencies			Specifies if optional dependencies should be excluded.
*body	ResolveServerToServerDependenciesRequest		Specifies a list of packages to resolve.

Responses

Status Code	Type	Description	Samples
200	ResolverPackageVersionDto[]	Success
400	ProblemDetails	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	Default	Notes
*serverToServerId			Specifies the ID of the server to return.
*packageId			Specifies the ID of the package to return. (Value needs double URI encoding.)
version			Specifies the version to return.
versionRange			Specifies the version range to return.
versionQuery			Specifies the version query to return.
includePreReleases			Specifies to return pre-releases.

Responses

Status Code	Type	Description	Samples
200	PackageVersionDto[]	Success
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

StartDownloadServerToServerPackages

Downloads specified packages from remote server.

Request

POST /api/v1/ServerToServer/{serverToServerId}/packages/download[?includeOptionalDependencies&wait]

Parameters

Name	Type	Default	Notes
*serverToServerId			Specifies the ID of the server.
includeOptionalDependencies			Specifies if optional dependencies should be downloaded.
wait			Specifies if the call should wait until the packages are downloaded.
*body	ResolverPackageQueryDto[]		Specifies the packages to download.

Responses

Status Code	Type	Description	Samples
200	TaskItemDto	Success

StartDownloadServerToServerInstaller

Downloads specified installer from remote server.

Request

POST /api/v1/ServerToServer/{serverToServerId}/installers/{installerId}/download[?includeOptionalDependencies&wait]

Parameters

Name	Type	Default	Notes
*serverToServerId			Specifies the ID of the server.
*installerId			Specifies the ID of the installer to download.
includeOptionalDependencies			Specifies if optional dependencies should be downloaded.
wait			Specifies if the call should wait until the installer is downloaded.

Responses

Status Code	Type	Description	Samples
200	TaskItemDto	Success

Settings

GetSettings

Gets the server settings.

Request

GET /api/v1/Settings

Responses

Status Code	Type	Description	Samples
200	ServerSettingsDto	Success
400	ProblemDetails	Bad Request

UpdateSettings

Updates the server settings.

Request

PUT /api/v1/Settings

Parameters

Name	Type	Default	Notes
*body	ServerSettingsDto		Specifies the settings information.

Responses

Status Code	Type	Description	Samples
204		No Content
400	ValidationProblemDetails	Bad Request

TestDatabaseConnection

Request

POST /api/v1/Settings/database/test

Parameters

Name	Type	Default	Notes
body	string

Responses

Status Code	Type	Description	Samples
204		No Content
400	ValidationProblemDetails	Bad Request

GetServerInfo

Get server info

Request

GET /api/v1/Settings/server

Responses

Status Code	Type	Description	Samples
200	ServerInfoDto	Success

GetServerDebug

Creates a Debug file with relevant server information

Request

GET /api/v1/Settings/server/debug

Responses

Status Code	Type	Description	Samples
200		Success

GetApplicationInsightsInfo

Get AppInsights Connection String

Request

GET /api/v1/Settings/applicationInsights

Responses

Status Code	Type	Description	Samples
200	string	Success

Tasks

GetTasks

Request

GET /api/Tasks[?type&Page&PerPage&OrderBy]

Parameters

Name	Type	Default	Notes
type
Page
PerPage
OrderBy

Responses

Status Code	Type	Description	Samples
200	TaskItemDtoPaginated	Success

CancelTask

Request

POST /api/Tasks/{guid}/cancel

Parameters

Name	Type	Default	Notes
*guid

Responses

Status Code	Type	Description	Samples
200		Success

DismissTask

Request

POST /api/Tasks/{guid}/dismiss

Parameters

Name	Type	Default	Notes
*guid

Responses

Status Code	Type	Description	Samples
200		Success

DismissAllTasks

Request

POST /api/Tasks/dismissAll

Responses

Status Code	Type	Description	Samples
200		Success

GetTask

Request

GET /api/Tasks/{guid}

Parameters

Name	Type	Default	Notes
*guid

Responses

Status Code	Type	Description	Samples
200	TaskItemDto	Success

Users

GetUsers

Request

GET /api/v1/Users[?filter&Page&PerPage&OrderBy]

Parameters

Name	Type	Default	Notes
filter
Page
PerPage
OrderBy

Responses

Status Code	Type	Description	Samples
200	UserDtoPaginated	Success

NewUser

Request

POST /api/v1/Users

Parameters

Name	Type	Default	Notes
*body	UserDto

Responses

Status Code	Type	Description	Samples
201	UserDto	Created
400	string	Bad Request

GetUser

Request

GET /api/v1/Users/{userId}

Parameters

Name	Type	Default	Notes
*userId

Responses

Status Code	Type	Description	Samples
200	UserDto	Success
400	string	Bad Request

GetMe

Request

GET /api/v1/Users/me

Responses

Status Code	Type	Description	Samples
200	UserDto	Success
400	string	Bad Request

GetRoles

Request

GET /api/v1/Users/roles

Responses

Status Code	Type	Description	Samples
200	RoleDto[]	Success

GetUserRoles

Request

GET /api/v1/Users/{userId}/roles

Parameters

Name	Type	Default	Notes
*userId

Responses

Status Code	Type	Description	Samples
200	RoleDto[]	Success
400	string	Bad Request

GrantRole

Request

POST /api/v1/Users/{userId}/roles

Parameters

Name	Type	Default	Notes
*userId
*body	RoleDto

Responses

Status Code	Type	Description	Samples
200		Success
400	string	Bad Request
404	string	Not Found

RemoveFromRole

Request

DELETE /api/v1/Users/{userId}/roles/{name}

Parameters

Name	Type	Default	Notes
*userId
*name

Responses

Status Code	Type	Description	Samples
200		Success
400	string	Bad Request
404	string	Not Found

SetUserEnabled

Request

PUT /api/v1/Users/{userId}/enabled

Parameters

Name	Type	Default	Notes
*userId

Responses

Status Code	Type	Description	Samples
200		Success
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

SetUserDisabled

Request

PUT /api/v1/Users/{userId}/disabled

Parameters

Name	Type	Default	Notes
*userId

Responses

Status Code	Type	Description	Samples
200		Success
400	ValidationProblemDetails	Bad Request
404	ProblemDetails	Not Found

Definitions

AuditLogDtoPaginated

Name	Type	Notes
data	AuditLogDto[]
total	integer (int32)

AuditLogDto

Name	Type	Notes
id	integer (int32)
userName	string
userId	string
operation	string
description	string
date	string (date-time)
beforeChanges	string
afterChanges	string

GoogleSettingsDto

Name	Type	Notes
clientId	string
secret	string
scopes	array
redirectUrl	string

TokenDto

Name	Type	Notes
token	string

LoginDto

Name	Type	Notes
token	string
user	UserDto[]
tokenExpires	string (date-time)

UserDto

Name	Type	Notes
userId	string
email	string
firstName	string
lastName	string
fullName	string
enabled	boolean

MicrosoftSettingsDto

Name	Type	Notes
clientId	string
scopes	array
redirectUrl	string
authorityEndpoint	string

ServerSettingsDto

Name	Type	Notes
serverId	string (uuid)
dbConnectionString	string
publicUrl	string
fileStorageDir	string
fileStorageAutomaticCleanupEnabled	boolean
serverName	string
codeSigningEnabled	boolean
codeSigningCertificateFindType	string
codeSigningCertificateFindValue	string
codeSigningCertificateStoreName	string
codeSigningCertificateStoreLocation	string
codeSigningTimestampServerUrl	string
azureStorageConnectionString	string
azureStorageContainerName	string
azureStorageEnabled	boolean
identityRequireAuthenticationOnServer	boolean
identityRequireAdministratorRoleOnServer	boolean
identityRequireAuthenticationOnClient	boolean
identityMicrosoftClientId	string
identityMicrosoftSecret	string
identityMicrosoftAuthorityEndpoint	string
enableResourceLocks	boolean

ValidationProblemDetails

Name	Type	Notes
type	string
title	string
status	integer (int32)
detail	string
instance	string
errors	object

ProblemDetails

Name	Type	Notes
type	string
title	string
status	integer (int32)
detail	string
instance	string

ClientCommandDto

Name	Type	Notes
id	string (uuid)
type	ClientCommandType
data	string

ClientCommandType

Enum Values

StartupInstaller
Installer

ClientDtoPaginated

Name	Type	Notes
data	ClientDto[]
total	integer (int32)

ClientDto

Name	Type	Notes
clientId	integer (int32)	Client ID.
label	string	Client label.
guid	string (uuid)	Unique identifier for client.
host	string	Hostname for client.
firstSeen	string (date-time)	First time the client was seen by the server.
lastSeen	string (date-time)	Last time the client was seen by the server.
version	string	Clients version.
isServer	boolean	Indicate if client is a server.

StorageSettingsDto

Name	Type	Notes
storageType	StorageType
azureStorageConnectionUri	string
expires	string (date-time)

StorageType

Enum Values

AzureStorage
FileStorage

FileDto

Name	Type	Notes
hash	string
size	integer (int64)
compressedSize	integer (int64)
compressedHash	string
compressedPath	string

GroupDtoPaginated

Name	Type	Notes
data	GroupDto[]
total	integer (int32)

GroupDto

Name	Type	Notes
groupId	string (uuid)
name	string
description	string
schedule	ScheduleDto[]
scheduleId	string (uuid)

ScheduleDto

Name	Type	Notes
scheduleId	string (uuid)
name	string
description	string
active	boolean
scheduleWindows	ScheduleWindowDto[]

ScheduleWindowDto

Name	Type	Notes
scheduleWindowId	integer (int32)
scheduleId	string (uuid)
sunday	boolean
monday	boolean
tuesday	boolean
wednesday	boolean
thursday	boolean
friday	boolean
saturday	boolean
start	string (time-span)
end	string (time-span)

InstallInstructionDto

Name	Type	Notes
installInstructionId	string (uuid)
name	string
description	string
steps	InstallInstructionStepDto[]

InstallInstructionStepDto

Name	Type	Notes
installInstructionStepId	string (uuid)
packageId	string
instanceName	string
versionQuery	string
remove	boolean
index	integer (int32)
installInstructionId	string (uuid)
arguments	InstallInstructionStepArgumentDto[]

InstallInstructionStepArgumentDto

Name	Type	Notes
installInstructionStepArgumentId	string (uuid)
installInstructionStepId	string (uuid)
key	string
value	string

InstallInstructionDtoPaginated

Name	Type	Notes
data	InstallInstructionDto[]
total	integer (int32)

InstallInstructionStepDtoPaginated

Name	Type	Notes
data	InstallInstructionStepDto[]
total	integer (int32)

PackageParameterDto

Name	Type	Notes
packageId	string
version	string
parameters	ParameterDto[]

ParameterDto

Name	Type	Notes
description	string
key	string
defaultValue	string
manualValue	string
widget	WidgetEnum
required	boolean
hidden	boolean
hint	string
labels	array
values	array

WidgetEnum

Enum Values

TextBox
Password
Numeric
CheckBox
Database
OpenFile
SaveFile
OpenFolder
OpenDatabase
NewDatabase
DropDown

InstallerDtoPaginated

Name	Type	Notes
data	InstallerDto[]
total	integer (int32)

InstallerDto

Name	Type	Notes
installerId	string (uuid)
name	string
description	string
packages	InstallerPackageDto[]
instructions	InstallerInstructionDto[]

InstallerPackageDto

Name	Type	Notes
installerPackageId	integer (int32)
packageId	string
versionQuery	string
instanceNameSuggestion	string
updateStrategy	string
description	string

InstallerInstructionDto

Name	Type	Notes
installerInstructionId	integer (int32)
index	integer (int32)
installInstructionId	string (uuid)
installInstruction	InstallInstructionDto[]

InstallerPackageDtoPaginated

Name	Type	Notes
data	InstallerPackageDto[]
total	integer (int32)

InstallerInstructionDtoPaginated

Name	Type	Notes
data	InstallerInstructionDto[]
total	integer (int32)

InstallTelemetryDtoPaginated

Name	Type	Notes
data	InstallTelemetryDto[]
total	integer (int32)

InstallTelemetryDto

Name	Type	Notes
guid	string (uuid)
clientId	integer (int32)
clientGuid	string (uuid)
clientLabel	string
serverOrigin	string (uuid)
packages	InstallTelemetryPackageDto[]
executions	InstallTelemetryExecutionDto[]
start	string (date-time)
end	string (date-time)
downloadStart	string (date-time)
downloadEnd	string (date-time)
installStart	string (date-time)
installEnd	string (date-time)
user	string
apiUserId	string
apiUser	AppIdentityUser[]
clientVersion	string
componentType	ComponentTypes
restartRequired	boolean
error	boolean

InstallTelemetryPackageDto

Name	Type	Notes
packageId	string
packageVersion	string
previousVersion	string
parameters	object
instanceName	string
hash	string
command	string
selected	boolean

InstallTelemetryExecutionDto

Name	Type	Notes
packageId	string
instanceName	string
command	string
start	string (date-time)
end	string (date-time)
error	boolean
errorMessage	string
errorStackTrace	string
errorScriptStackTrace	string
restartRequired	boolean
log	string
eventLogs	string

AppIdentityUser

Name	Type	Notes
id	string
userName	string
normalizedUserName	string
email	string
normalizedEmail	string
emailConfirmed	boolean
passwordHash	string
securityStamp	string
concurrencyStamp	string
phoneNumber	string
phoneNumberConfirmed	boolean
twoFactorEnabled	boolean
lockoutEnd	string (date-time)
lockoutEnabled	boolean
accessFailedCount	integer (int32)
firstName	string
lastName	string
enabled	boolean

ComponentTypes

Enum Values

Unknown
Server
ServerCmdlet
ClientCmdlet
ClientWizard
ClientService

InstallTelemetryPackageDtoPaginated

Name	Type	Notes
data	InstallTelemetryPackageDto[]
total	integer (int32)

InstallTelemetryExecutionDtoPaginated

Name	Type	Notes
data	InstallTelemetryExecutionDto[]
total	integer (int32)

PackageDtoPaginated

Name	Type	Notes
data	PackageDto[]
total	integer (int32)

PackageDto

Name	Type	Notes
packageId	string
name	string

PackageManifestDto

Name	Type	Notes
manifest	ManifestDto[]
files	PackageVersionFileDto[]

ManifestDto

Name	Type	Notes
name	string	Name of package.
id	string	Package id.
version	string	Package version.
minClientVersion	string	Min version client needs to run.
displayName	string	Display name, presented to the user. If not set "Name" will be used.
description	string	Description of package.
instance	boolean	Is an instance package, i.e. can be installed multiple times.
commands	object	Commands in the package and reference to it's PowerShell implementation.
dependencies	Dependency[]	List of package dependencies.
parameters	ParameterDto[]	Parameters needed for package.
fillParameters	object	Arguments for other packages.
prefetchFiles	array	List of files to prefetch before package installation (for validation), must be relative to package directory.
storeFiles	array	List of files to store in package after the package has been installed (files necessary to remove the package).
alwaysUpdateDependencies	boolean
substituteFor	string	Substitute this package for specified package.
windowsUpdateSensitive	boolean	Specifies if package installation is sensitive to Windows Updates and is likely to fail.

Dependency

List of package dependencies.

Name	Type	Notes
packageId	string
versionQuery	string
optional	boolean
onlyRestrictVersion	boolean

PackageVersionFileDto

Name	Type	Notes
hash	string
filePath	string
size	integer (int64)
compressedSize	integer (int64)
compressedHash	string
prefetch	boolean
store	boolean

PackageVersionDtoPaginated

Name	Type	Notes
data	PackageVersionDto[]
total	integer (int32)

PackageVersionDto

Name	Type	Notes
packageId	string
name	string
displayName	string
description	string
version	string
dateTime	string (date-time)
hash	string
instance	boolean

PackageVersionFileDtoPaginated

Name	Type	Notes
data	PackageVersionFileDto[]
total	integer (int32)

PackageDependencyDto

Name	Type	Notes
packageId	string
version	string
dependencies	Dependency[]

PersonalTokenDtoPaginated

Name	Type	Notes
data	PersonalTokenDto[]
total	integer (int32)

PersonalTokenDto

Name	Type	Notes
personalTokenId	integer (int32)
name	string
description	string
expirationDate	string (date-time)
revoked	boolean

ResolveDependenciesRequest

Name	Type	Notes
packagesFrom	ResolverPackageQueryDto[]
packagesTo	ResolverPackageQueryDto[]

ResolverPackageQueryDto

Name	Type	Notes
packageId	string
versionQuery	string

ResolverPackageVersionDto

Name	Type	Notes
packageId	string
displayName	string
description	string
normalizedVersion	string
version	string
instance	boolean
hash	string
dateTime	string
previousVersion	string

ScheduleDtoPaginated

Name	Type	Notes
data	ScheduleDto[]
total	integer (int32)

ScheduleWindowDtoICollectionPaginated

Name	Type	Notes
data	array
total	integer (int32)

ScheduleNextUpdateDto

Name	Type	Notes
clientId	string (uuid)
time	string (date-time)
operation	string

ServerToServerDtoPaginated

Name	Type	Notes
data	ServerToServerDto[]
total	integer (int32)

ServerToServerDto

Name	Type	Notes
id	integer (int32)
url	string	URL of external server to connect too.
guid	string (uuid)	Remote server unique Guid identification
name	string	Name of external server.
username	string	User to connect with the server.
personalAccessToken	string	Personal Access Token to connect with the server.

ResolveServerToServerDependenciesRequest

Name	Type	Notes
packagesFrom	ResolverPackageQueryDto[]
packagesTo	ResolverPackageQueryDto[]

TaskItemDto

Name	Type	Notes
taskId	string (uuid)
dateStarted	string (date-time)
dateEnded	string (date-time)
data
taskName	string
taskStatus	TaskStatus
taskType	string
canCancel	boolean
progressBars	IProgressBar[]

TaskStatus

Enum Values

Created
WaitingForActivation
WaitingToRun
Running
WaitingForChildrenToComplete
RanToCompletion
Canceled
Faulted

IProgressBar

Name	Type	Notes
activity	string
status	string
percent	integer (int32)
indeterminate	boolean
error	boolean

ServerInfoDto

Name	Type	Notes
name	string	Name of the server.
serverId	string (uuid)	ID of the server.
version	string	Server's version.
redirectUrl	string	If set, clients should redirect to this URL.
clientAuthenticationType	AuthenticationTypeEnum[]	Supported client authentication.
serverAuthenticationType	AuthenticationTypeEnum[]	Supported server authentication.
runningOnAzure	boolean	Server is running under Azure Environment

AuthenticationTypeEnum

Supported client authentication.

TaskItemDtoPaginated

Name	Type	Notes
data	TaskItemDto[]
total	integer (int32)

UserDtoPaginated

Name	Type	Notes
data	UserDto[]
total	integer (int32)

RoleDto

Name	Type	Notes
name	string