SEI API Guide
Overview
This topic explains how to interact with the Harness SEI APIs, including details about service endpoints, authentication, content types, and pagination. This allows you to access and manage various resources programmatically within Harness SEI.
For detailed documentation of endpoints and other Harness SEI API reference information, go to the Harness API reference documentation.
Service endpoint
A service endpoint is the base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoints and all URIs below are relative to this service endpoint:
Harness SEI Environments
Authentication
For authentication, use an SEI API key in the Authorization header:
Authorization: API KEY <HARNESS_SEI_API_KEY>
Note that the SEI API key is different from a Harness Platform key. You can generate SEI API keys in the SEI module at the Account level.
Follow the steps below to generate an SEI API Key in Harness.
- Go the Harness SEI Account and select API KEYS under the SEI Settings
- Click on the Create API Key button at the top right corner
- Add a name and description for the API Key
- Choose the role as either Admin or Ingestion. For this use case select the role of Admin.
- Click on the Create button to generate the API Key.
Content-Type
All payloads are to be in JSON format. Use the following header when making requests:
Content-Type: application/json
Pagination
Some API endpoints that return a list of records support pagination to manage large datasets efficiently.
Request Parameters
Include these parameters in your request payload to control pagination:
{
"page": 0,
"page_size": 100
}
Response Metadata
The response will include a metadata object with pagination information:
{
"_metadata": {
"page_size": 100,
"page": 0,
"has_next": true,
"total_count": 256
}
}
This metadata helps you determine how much more data is available for retrieval in subsequent requests.
Reference documentation
For detailed documentation of endpoints and other Harness SEI API reference information, go to the Harness API reference documentation.