Atlassian: Get Jira instance info

Atlassian serverInfo.getServerInfo: arguments, response, policy and SDK examples.

Operation atlassian.getserverinfo

Provider route: GET /{cloudId}/rest/api/3/serverInfo. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/atlassian with npm, or alter-sdk-atlassian with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { AtlassianIntegration } from "@alter-ai/atlassian";

async function execute(input: Parameters<AtlassianIntegration["serverInfo"]["getServerInfo"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new AtlassianIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.serverInfo.getServerInfo(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_atlassian import AtlassianIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = AtlassianIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.server_info.get_server_info(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`path`	object	Required within parent	Additional keys: not allowed
`path.cloudId`	string	Required within parent	Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	Model	Root	Expand Get Jira instance info — response body

Referenced models: Get Jira instance info — response body

Schemas

Get Jira instance info — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Details about the Jira instance.
`baseUrl`	JSON	Optional
`baseUrl (anyOf 1)`	string	Alternative	The base URL of the Jira instance.
`baseUrl (anyOf 2)`	null	Alternative
`buildDate`	JSON	Optional
`buildDate (anyOf 1)`	JSON	Alternative
`buildDate (anyOf 1) (anyOf 1)`	string	Alternative	The timestamp when the Jira version was built.
`buildDate (anyOf 1) (anyOf 2)`	integer	Alternative
`buildDate (anyOf 2)`	null	Alternative
`buildNumber`	JSON	Optional
`buildNumber (anyOf 1)`	JSON	Alternative
`buildNumber (anyOf 1) (anyOf 1)`	integer	Alternative	The build number of the Jira version. Format: int32
`buildNumber (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`buildNumber (anyOf 2)`	null	Alternative
`deploymentType`	JSON	Optional
`deploymentType (anyOf 1)`	string	Alternative	The type of server deployment. This is always returned as Cloud.
`deploymentType (anyOf 2)`	null	Alternative
`displayUrl`	JSON	Optional
`displayUrl (anyOf 1)`	string	Alternative	The display URL of the Jira instance.
`displayUrl (anyOf 2)`	null	Alternative
`displayUrlConfluence`	JSON	Optional
`displayUrlConfluence (anyOf 1)`	string	Alternative	The display URL of Confluence.
`displayUrlConfluence (anyOf 2)`	null	Alternative
`displayUrlServicedeskHelpCenter`	JSON	Optional
`displayUrlServicedeskHelpCenter (anyOf 1)`	string	Alternative	The display URL of the Servicedesk Help Center.
`displayUrlServicedeskHelpCenter (anyOf 2)`	null	Alternative
`healthChecks`	JSON	Optional
`healthChecks (anyOf 1)`	array	Alternative	Jira instance health check results. Deprecated and no longer returned.
`healthChecks (anyOf 1)[]`	Model	Each item	Expand Get Jira instance info — response body — health Checks array item
`healthChecks (anyOf 2)`	null	Alternative
`scmInfo`	JSON	Optional
`scmInfo (anyOf 1)`	string	Alternative	The unique identifier of the Jira version.
`scmInfo (anyOf 2)`	null	Alternative
`serverTime`	JSON	Optional
`serverTime (anyOf 1)`	JSON	Alternative
`serverTime (anyOf 1) (anyOf 1)`	string	Alternative	The time in Jira when this request was responded to.
`serverTime (anyOf 1) (anyOf 2)`	integer	Alternative
`serverTime (anyOf 2)`	null	Alternative
`serverTimeZone`	JSON	Optional
`serverTimeZone (anyOf 1)`	string	Alternative	The default timezone of the Jira server. In a format known as Olson Time Zones, IANA Time Zones or TZ Database Time Zones.
`serverTimeZone (anyOf 2)`	null	Alternative
`serverTitle`	JSON	Optional
`serverTitle (anyOf 1)`	string	Alternative	The name of the Jira instance.
`serverTitle (anyOf 2)`	null	Alternative
`version`	JSON	Optional
`version (anyOf 1)`	string	Alternative	The version of Jira.
`version (anyOf 2)`	null	Alternative
`versionNumbers`	JSON	Optional
`versionNumbers (anyOf 1)`	array	Alternative	The major, minor, and revision version numbers of the Jira version.
`versionNumbers (anyOf 1)[]`	JSON	Each item
`versionNumbers (anyOf 1)[] (anyOf 1)`	integer	Alternative	Format: int32
`versionNumbers (anyOf 1)[] (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`versionNumbers (anyOf 2)`	null	Alternative

Referenced models: Get Jira instance info — response body — health Checks array item

Get Jira instance info — response body — health Checks array item

Field	Type	Presence	Description and constraints
`$`	object	Root	Jira instance health check results. Deprecated and no longer returned.
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative	The description of the Jira health check item.
`description (anyOf 2)`	null	Alternative
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	The name of the Jira health check item.
`name (anyOf 2)`	null	Alternative
`passed`	JSON	Optional
`passed (anyOf 1)`	boolean	Alternative	Whether the Jira health check item passed or failed.
`passed (anyOf 2)`	null	Alternative

Policy, approvals and errors

SDK function policy ID: atlassian.getserverinfo. Catalog operation: getserverinfo. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source

Report an issue with this page