GroundControl Documentation
Welcome to the GroundControl documentation, where you'll discover two primary sections:
-
General Purpose Guides: These guides are designed to help you become acquainted with essential concepts, such as understanding actors and best practices for testing.
-
API Documentation: This section provides comprehensive explanations for both the REST API and the various SDKs available for your use.
API Documentation
GroundControl provides two main options for integration: SDKs and a REST API.
- The SDKs, which focus on allowing your application code to verify the status of a status flag.
- On the other hand, the REST API allows you to manage various aspects of your projects. This includes tasks such as creating and updating feature flags and projects, as well as initiating Pull Requests to remove feature flags from your codebase, among other functionalities.
Getting started
To get started, create a new project in your dashboard, then read about how to make requests for the resources you need to access using our HTTP APIs or dedicated client SDKs.
You will need to create an API key in order to use the API or the SDKs. In your project go to Settings → API keys and create a new API key.
Resources
Feature flagss
Learn about the contact model and how to create, retrieve, update, delete, and list contacts.
Actors
Learn about the conversation model and how to create, retrieve, update, delete, and list conversations.
Pull Requests
Learn about the message model and how to create, retrieve, update, delete, and list messages.