API reference and authentication

The Concert 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 Concert API.

Base URL

The base URL specifies of the host name of the Concert 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 Concert deployment you are using.

https://${concert_host}:{port}
Variable Description
${concert_host} Hostname of the Concert 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 may vary for VM deployments.

API headers

The following headers must be included in Concert 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 <type> of API key being provided which differs based on your deployment type. For example, C_API_KEY for SaaS and VM deployments, and ZenAPIKey OCP deployments. Then, enter the unique API key secret provided upon generating the API key.
    -H "Authorization: <type> <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