Class ServerInfoService

This resource provides information about the Jira instance.

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-server-info

Hierarchy

  • CommonHttpService
    • ServerInfoService

Constructors

constructor

Methods

getServerInfo initialize

Constructors

constructor

  • new ServerInfoService(getClientInstance): ServerInfoService
  • Internal

    Create a new instance of the service.

    Parameters

    • getClientInstance: (() => CommonHttpClient)
        • (): CommonHttpClient

        • Returns CommonHttpClient

    Returns ServerInfoService

Methods

getServerInfo

  • getServerInfo(): Promise<ServerInformation>

  • Returns information about the Jira instance.

    This operation can be accessed anonymously.

    Permissions required: None.

    Returns Promise<ServerInformation>

    Returned if the request is successful.

    example:

    {
      "baseUrl": "https://your-domain.atlassian.net",
      "buildDate": "2020-03-26T22:20:59.000+0000",
      "buildNumber": 582,
      "defaultLocale": {
        "locale": "en_AU"
      },
      "displayUrl": "https://instance.jira.your-domain.com",
      "displayUrlConfluence": "https://instance.confluence.your-domain.com",
      "displayUrlServicedeskHelpCenter": "https://instance.help.your-domain.com",
      "scmInfo": "1f51473f5c7b75c1a69a0090f4832cdc5053702a",
      "serverTime": "2020-03-31T16:43:50.000+0000",
      "serverTimeZone": "Australia/Sydney",
      "serverTitle": "My Jira instance",
      "version": "1001.0.0-SNAPSHOT",
      "versionNumbers": [
        5,
        0,
        0
      ]
    }

    Path

    GET /rest/api/3/serverInfo @scopes-current @scopes-beta

    See

    https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-server-info#api-rest-api-3-serverinfo-get

Protected Staticinitialize

  • initialize(): void

  • Method to initialize the class. Normally used to set up validation rules.

    Returns void

Settings

Member Visibility

On This Page

Constructors
Methods