Skip to main content

REST-API Connection Troubleshooting

  • Updated

There are a number of queries that can be executed via CMD (Command Line) to test REST-API connectivity. Admin rights are not required for this. 

Execute the queries on the machines where you are trying to establish a connection. Depending on usage, this could be machines running PowerBi, Excel, your Confluence Server, or any other third-party product.

 

Querying Basic Connectivity

On premise - BOC product in your own Infrastructure

curl https://<SERVER_NAME>:<PORT>/<PRODUCT><VERSION>/rest/connection

Cloud (SaaS) - BOC product hosted by us

curl https://example-pp123456.boc-cloud.com/rest/connection

Positive Response:

REST Connection Service Evaluation invoked @ Mon Mar 10 15:50:36 CET 2025

If this query was successful, you can proceed with the following tests.


Negative Response 1: 

--connect-timeout

A possible network issue exists. The REST command does not reach your Apache Tomcat server.

 

Negative Response 2: 

Any other response indicates a possible proxy between your machine and the Tomcat server.

The following elements may be involved:

  • Reverse Proxy
  • Firewall
  • IIS

Log files of the individual components in your infrastructure may provide insight into a solution.


Querying Basic Authentication

On premise - BOC product in your own Infrastructure

curl -u "username:password" https://<SERVER_NAME>:<PORT>/<PRODUCT><VERSION>/rest/connection/auth

Cloud (SaaS) - BOC product hosted by us

curl -u "username:password" https://example-pp123456.boc-cloud.com/rest/connection/auth

Important: Basic Auth must be enabled and configured for this to work. The test only works with local, non technical users: Basic Authentication | BOC Developer Portal
 
ADONIS 16, ADOIT 17, and ADOGRC 13 and later: Basic Auth Guide
Before ADONIS 16, ADOIT 17, and ADOGRC 13: Basic Auth Guide

 

Positive Response:

Authorized Access Granted @ Mon Mar 10 15:54:54 CET 2025


Negative Response 1: 

Unauthorized : basic_auth_invalid 

Possible reasons:

  • Incorrect user credentials
  • An IDM or technical user was used
  • Basic Auth not enabled/fully configured
     

Negative Response 2: 

basic_auth_not_allowed

Possible reason:

  • Your IP is not listed in the allowlist. See the Basic Auth Guide for more details.


Querying a Repository

On premise - BOC product in your own Infrastructure

curl -u "username:password" https://<SERVER_NAME>:<PORT>/<PRODUCT><VERSION>/rest/<restversion>/repos

Cloud (SaaS) - BOC product hosted by us

curl -u "username:password" https://example-pp123456.boc-cloud.com/rest/<restversion>/repos


Positive Response:

{"repos":[{"id":"{163197e6-b923-495b-a1be-814af464a620}","name":"Standard Repository"}]}


Negative Response 1:

basic_auth_invalid

Possible reason:

  • Incorrect credentials entered


Negative Response 2: 

{"repos":[]}

Possible reason:

  • No repositories assigned to user

 

Further Information on REST-API

Welcome to the BOC Developer Portal | BOC Developer Portal


 

Related articles