Calling APIs on Connect from curl

Requirements

To call APIs hosted in Connect from curl, you’ll need:

  1. URL for the API endpoint hosted on Connect
  2. API key (if your API requires authorization)

curl Example

You can use the curl command-line tool on Linux to call APIs from terminals, shell scripts, or CI/CD systems:

export CONNECT_API_URL=https://connect.yourcompany.com/rest-api-example/endpoint
export CONNECT_API_KEY=YfB5XBRB7slkkBSEi5qr93mWJvbpXQQy

curl -H "Authorization: Key ${CONNECT_API_KEY}" ${CONNECT_API_URL}

You can replace the values of CONNECT_API_URL and CONNECT_API_KEY with your API URL and API key from Connect.

Scope

The code examples assume that you are calling a published API in Connect that is:

  • Hosted on a secure server with TLS/SSL at an HTTPS endpoint
  • Using an API key to make an authorized call to an API
  • Making an HTTP GET request to the API

If your use case is different, then you can modify the example code accordingly.

Back to top