Introduction

01Getting Started

1

Create an Account

Sign up at sharkcluster.com to get your workspace ID and initial API credentials.

2

Generate API Keys

Navigate to Settings > API Keys to generate your Production and Sandbox keys.

3

First Request

Use your Secret Key to make your first request to the /v1/me endpoint to verify connectivity.

02Core Concepts

Clusters

Logical groupings of compute resources across different geographic regions.

Shark Nodes

Individual virtual or bare-metal instances running within your clusters.

Auto-Scaling

Dynamic resource adjustment based on real-time traffic and CPU load.

03Base API Endpoint

Service URLhttp://localhost:8001/

04Authentication Protocol

The Shark API uses API keys to authenticate requests. You can view and manage your API keys in the Shark Dashboard. Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.