Jira Data Center: the connection doesn't become ready after saving
Jira Data Center (and Jira Server) runs on your customer's own infrastructure, so Apideck has to reach it over the internet. When a consumer saves their Jira Data Center details in Vault, Apideck checks the connection by fetching the current user from Jira. If that check can't complete, the connection doesn't become ready, and calls to it fail.
This article helps you find out why.
The most common causes
Apideck can't reach the server. The Jira instance is behind a firewall, VPN or private network that doesn't allow connections from Apideck.
A login page sits in front of Jira. A single sign-on (SSO) gateway or reverse proxy intercepts the request and returns its own login page instead of passing it to Jira.
The personal access token is wrong or expired. Jira Data Center connections use a Personal Access Token (PAT), available from Jira Data Center/Server 8.14. The token is only shown once when it's created.
The server URL is wrong. The Server Base URL should be the base address of the Jira instance (for example
jira.example.com), without/restor any page path.
Check it yourself with the Proxy API
You can run the same check Apideck runs through the Proxy API, using the consumer's existing connection:
curl --request GET 'https://unify.apideck.com/proxy' \
--header 'Authorization: Bearer {YOUR_APIDECK_API_KEY}' \
--header 'x-apideck-app-id: {YOUR_APP_ID}' \
--header 'x-apideck-consumer-id: {CONSUMER_ID}' \
--header 'x-apideck-service-id: jira-data-center' \
--header 'x-apideck-downstream-url: https://{JIRA_HOST}/rest/api/2/myself'
What the result tells you:
You get back | It means | What to do |
|---|---|---|
A JSON object describing a Jira user | Apideck can reach Jira and the token works | Open the connection in Vault and save it again |
An HTML page (often a login page) | An SSO gateway or proxy is in front of Jira | Ask the customer's IT team to let API requests with a bearer token through to Jira, or expose the API on an address without the SSO layer |
No response, then a timeout after about 30 seconds | Apideck can't reach the server | Ask the customer's IT team to allow incoming connections from Apideck's fixed IP addresses, listed in the Static IP section of the Proxy API docs. |
| The token is wrong, expired or revoked | Create a new Personal Access Token in Jira and update it in Vault |
Tip: a check run from the customer's own network (for example from their laptop on the office VPN) can succeed even when Apideck can't connect. The Proxy API check runs from Apideck, which is the test that matters.
Still stuck?
Contact Apideck support through the Customer Portal (the Requests link at the top of this help center), your Slack channel with us, or support@apideck.com. Include the consumer ID and the result of the Proxy API check.