Omnistrate API resources¶
Omnistrate supports REST API as a programmatic alternative to the UI for creating and managing Omnistrate projects. It allows you to automate processes and iterate more quickly, and lets you use Omnistrate from your own UI. You can use the API with Omnistrate supported client in Golang, or with your own custom code. The Golang client is supported in Windows, UNIX, and OS X environments.
For manual interaction and CI/CD automation we recommend using Omnistrate Command Line, which simplifies the interaction with Omnistrate APIs.
Getting Started¶
New users can review the Build Guideline / Build Your Own Portal to configure their environments and get started building a custom portal using Omnistrate's APIs.
Reference documentation¶
Omnistrate offers reference documentation available for the following programmatic tools.
| Topic | Description |
|---|---|
| Omnistrate Build REST API | The Omnistrate REST API provides a programmatic alternative to the UI for building Omnistrate services. |
| Omnistrate Consumption REST API | The Omnistrate REST API provides a programmatic alternative to the UI for consuming Omnistrate services. |
| Omnistrate Fleet REST API | The Omnistrate REST API provides a programmatic alternative to the UI for operating Omnistrate services. |
| OpenAPI specification for Build API | Omnistrate customers can reference the OpenAPI specification for the Omnistrate REST API. It helps automate the generation of a client for languages that Omnistrate doesn't offer a client. It assists with design, implementation, and testing integration with Omnistrate's REST API using a variety of automated OpenAPI-compatible tools. (yaml / json) |
| OpenAPI specification for Consumption API | Omnistrate customers can reference the OpenAPI specification for the Omnistrate REST API. It helps automate the generation of a client for languages that Omnistrate doesn't offer a client. It assists with design, implementation, and testing integration with Omnistrate's REST API using a variety of automated OpenAPI-compatible tools. (yaml / json) |
| OpenAPI specification for Fleet API | Omnistrate customers can reference the OpenAPI specification for the Omnistrate REST API. It helps automate the generation of a client for languages that Omnistrate doesn't offer a client. It assists with design, implementation, and testing integration with Omnistrate's REST API using a variety of automated OpenAPI-compatible tools. (yaml / json) |
| Omnistrate Go SDK | The Omnistrate Go SDK provides an API client to interact with Omnistrate APIs from Go applications and services. The Go SDK includes Build, Consumption and Fleet API references. |