API reference and authentication

Edit online

The IBM® Sovereign Core Compliance center API is a RESTful API enabling seamless data ingestion and other operations. It utilizes standard JSON requests and responses, and responds with HTTP status codes. You can use a cURL command-line tool to invoke the IBM Sovereign Core Compliance center API.

Note: Refer to the https://developer.ibm.com/apis/catalog/concert--ibm-concert-api for a full index of endpoints and requests.

Base URL

The base URL specifies of the host name of the IBM Sovereign Core Compliance center API server and the port on which it is listening for incoming requests, separated by a colon. The host name and port values may vary depending on the type of IBM Sovereign Core Compliance center deployment you are using.

https://${concert_host}:${port}
Table 1. API configuration variables
Variable Description
${concert_host} Hostname of the IBM Sovereign Core Compliance center API server.
${port} Number of the port on which the API server is listening for incoming requests. For SaaS and OCP deployments, the port value of 443. The port number depends on how your VM installation is configured or if you have a proxy or load balancer in front of the IBM Sovereign Core Compliance center installation.

API headers

When using the cURL utility, the following headers must be included in IBM Sovereign Core Compliance center API requests:
  • Accept: This header indicates the media type that the client expects the server to return in the response. For example, the following "accept" header indicates the requesting client expects a JSON response. 
    -H 'accept: application/json'
  • InstanceID: This header indicates the unique ID of the Concert instance. This value is displayed after generating an API key. 
    -H "InstanceId: 0000-0000-0000-0000"
  • Authorization: This header is used to authenticate the API requests. It contains the C_API_KEY type followed by the unique API key secret provided upon generating the API key. 
    -H "Authorization: C_API_KEY <API_key>"
  • Content-Type: This header specifies the content type of the request body. For Concert API requests, set this to multipart/form-data. 
    -H 'Content-Type: multipart/form-data'

Next steps