API Overview
You can use Kordon’s API to build scripts and applications that automate processes, integrate with Kordon, and extend Kordon. For example, you could use the API to sync assets with your asset management system.
Each REST API endpoint is documented individually, and the endpoints are categorized by the resource that they primarily affect.
Every request to the REST API includes an HTTP method and a path. Depending on the REST API endpoint, you might also need to specify request headers, authentication information, query parameters, or body parameters.
Where possible, the Kordon REST API strives to use an appropriate HTTP method for each action.
- GET Used for retrieving resources.
- POST Used for creating resources.
- PATCH Used for updating properties of resources.
- DELETE Used for deleting resources.
Base URL
Section titled “Base URL”All API requests should be made to:
https://YOUR_KORDON_URL/api/v1/API Resources
Section titled “API Resources”- Authentication - Learn how to authenticate your requests
- Error Handling - Understanding API errors and responses
- Pagination - Working with paginated results
- Users API - Manage user accounts, permission roles and settings
- Assignables API - Manage user groups and roles.
- Assets API - Manage assets
- Vendors API - Manage vendors
- Risks API - Manage risks
- Tasks API - Manage tasks