Documentation
Learn how to use Orbital7's platform, including tutorials, API references, and troubleshooting guides.
Getting Started
Installation
Begin by installing the Orbital7 CLI tool. This provides command-line access to all core features.
npm install -g @orbital7/cli
Verify installation with:
orbital7 --version
Configuration
Configure your local environment with API access credentials.
orbital7 config set --api-key=your_api_key_here
Validate your setup:
orbital7 status
API Reference
Core Endpoints
POST /projects
Create a new project with base configuration.
{
"name": "my-project",
"region": "us-east-1"
}
GET /projects/{id}
Retrieve project details by ID.
Response: 200 OK
{
"id": "12345",
"status": "active",
"createdAt": "2025-08-27T14:30:00Z"
}