ServerApi

getServerInfo

Get the server info.


Endpoint	/app/rest/server
Produces	`application/xml` `application/json`
Parameters	`fields: string`
Response	`Server`

getBackupStatus

Get the latest backup status.


Endpoint	/app/rest/server/backup
Produces	`text/plain`
Response	`string`

startBackup

Start a new backup.


Endpoint	/app/rest/server/backup
Produces	`text/plain`
Parameters	`fileName: string` `addTimestamp: boolean` `includeConfigs: boolean` `includeDatabase: boolean` `includeBuildLogs: boolean` `includePersonalChanges: boolean` `includeRunningBuilds: boolean` `includeSupplimentaryData: boolean`
Response	`string`

getCleanupSettings

Get clean-up settings.


Endpoint	/app/rest/server/cleanup
Produces	`application/xml` `application/json`
Response	`Cleanup`

setCleanupSettings

Set clean-up settings.


Endpoint	/app/rest/server/cleanup
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`body: Cleanup`
Response	`Cleanup`

getFilesListOfServer

List all files.


Endpoint	/app/rest/server/files/{areaId}
Produces	`application/xml` `application/json`
Parameters	`areaId: string` `basePath: string` `locator: string` `fields: string`
Response	`Files`

getZippedFileOfServer

Get specific file zipped.


Endpoint	/app/rest/server/files/{areaId}/archived{path}
Produces	`/`
Parameters	`path: string` `areaId: string` `basePath: string` `locator: string` `name: string`

downloadFileOfServer

Download specific file.


Endpoint	/app/rest/server/files/{areaId}/files{path}
Produces	`/`
Parameters	`path: string` `areaId: string`

getFileMetadataOfServer

Get metadata of specific file.


Endpoint	/app/rest/server/files/{areaId}/metadata{path}
Produces	`application/xml` `application/json`
Parameters	`path: string` `areaId: string` `fields: string`
Response	`file`

getFilesListForSubpathOfServer

List files under this path.


Endpoint	/app/rest/server/files/{areaId}/{path}
Produces	`application/xml` `application/json`
Parameters	`path: string` `areaId: string` `basePath: string` `locator: string` `fields: string`
Response	`Files`

getLicensingData

Get the licensing data.


Endpoint	/app/rest/server/licensingData
Produces	`application/xml` `application/json`
Parameters	`fields: string`
Response	`LicensingData`

getLicenseKeys

Get all license keys.


Endpoint	/app/rest/server/licensingData/licenseKeys
Produces	`application/xml` `application/json`
Parameters	`fields: string`
Response	`LicenseKeys`

addLicenseKeys

Add license keys.


Endpoint	/app/rest/server/licensingData/licenseKeys
Consumes	`text/plain`
Produces	`application/xml` `application/json`
Parameters	`body: string` `fields: string`
Response	`LicenseKeys`

deleteLicenseKey

Delete a license key.


Endpoint	/app/rest/server/licensingData/licenseKeys/{licenseKey}
Parameters	`licenseKey: string`

getLicenseKey

Get a license key.


Endpoint	/app/rest/server/licensingData/licenseKeys/{licenseKey}
Produces	`application/xml` `application/json`
Parameters	`licenseKey: string` `fields: string`
Response	`LicenseKey`

getAllMetrics

Get metrics.


Endpoint	/app/rest/server/metrics
Produces	`application/xml` `application/json`
Parameters	`fields: string`
Response	`Metrics`

getAllPlugins

Get all plugins.


Endpoint	/app/rest/server/plugins
Produces	`application/xml` `application/json`
Parameters	`fields: string`
Response	`Plugins`

getServerField

Get a field of the server info.


Endpoint	/app/rest/server/{field}
Produces	`text/plain`
Parameters	`field: string`
Response	`string`

Last modified: 22 May 2023