TeamCity 2021.1 Help

ServerApi

getServerInfo

Get the server info.

Endpoint

/app/rest/server

HTTP method

GET

Produces

  • application/xml
  • application/json

Parameters

  • fields: string

Response

Server

getBackupStatus

Get the latest backup status.

Endpoint

/app/rest/server/backup

HTTP method

GET

Produces

  • text/plain

Response

string

startBackup

Start a new backup.

Endpoint

/app/rest/server/backup

HTTP method

POST

Produces

  • text/plain

Parameters

  • fileName: string
  • addTimestamp: boolean
  • includeConfigs: boolean
  • includeDatabase: boolean
  • includeBuildLogs: boolean
  • includePersonalChanges: boolean
  • includeRunningBuilds: boolean
  • includeSupplimentaryData: boolean

Response

string

getFilesListOfServer

List all files.

Endpoint

/app/rest/server/files/{areaId}

HTTP method

GET

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}

HTTP method

GET

Produces

  • */*

Parameters

  • path: string
  • areaId: string
  • basePath: string
  • locator: string
  • name: string

downloadFileOfServer

Download specific file.

Endpoint

/app/rest/server/files/{areaId}/files{path}

HTTP method

GET

Produces

  • */*

Parameters

  • path: string
  • areaId: string

getFileMetadataOfServer

Get metadata of specific file.

Endpoint

/app/rest/server/files/{areaId}/metadata{path}

HTTP method

GET

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}

HTTP method

GET

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

HTTP method

GET

Produces

  • application/xml
  • application/json

Parameters

  • fields: string

Response

LicensingData

getLicenseKeys

Get all license keys.

Endpoint

/app/rest/server/licensingData/licenseKeys

HTTP method

GET

Produces

  • application/xml
  • application/json

Parameters

  • fields: string

Response

LicenseKeys

addLicenseKeys

Add license keys.

Endpoint

/app/rest/server/licensingData/licenseKeys

HTTP method

POST

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}

HTTP method

DELETE

Parameters

  • licenseKey: string

getLicenseKey

Get a license key.

Endpoint

/app/rest/server/licensingData/licenseKeys/{licenseKey}

HTTP method

GET

Produces

  • application/xml
  • application/json

Parameters

  • licenseKey: string
  • fields: string

Response

LicenseKey

getAllMetrics

Get metrics.

Endpoint

/app/rest/server/metrics

HTTP method

GET

Produces

  • application/xml
  • application/json

Parameters

  • fields: string

Response

Metrics

getAllPlugins

Get all plugins.

Endpoint

/app/rest/server/plugins

HTTP method

GET

Produces

  • application/xml
  • application/json

Parameters

  • fields: string

Response

Plugins

getServerField

Get a field of the server info.

Endpoint

/app/rest/server/{field}

HTTP method

GET

Produces

  • text/plain

Parameters

  • field: string

Response

string

Last modified: 20 February 2021