{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"bf2bd69c-397f-4d9c-b7c8-88efe5dd7c4d","name":"🐆 Guepard Platform - API Overview Documentation - 0.4.4-public","description":"### Guepard - The Future of Data Branching Environments 🚀\n\nGuepard is **revolutionizing** how companies store, manage, and access data with a **next-gen Serverless and Virtualized Data Environment**. By eliminating **data duplication**, accelerating **provisioning ⚡**, and automating **operations 🤖**, Guepard enables businesses to create **on-demand, isolated, and scalable** data environments across multiple database providers.\n\n#### 🔥 Why Choose Guepard?\n\n✅ **Instant Virtual Environments** – Spin up **disposable data environments** for development, testing, and AI workloads in seconds.\n\n🔄 **Data Branching & Versioning** – Clone, snapshot, and synchronize databases **without performance bottlenecks**.\n\n☁️ **On-Prem & Cloud Flexibility** – Deploy seamlessly across **private infrastructure**, cloud providers, or hybrid setups.\n\n💾 **Resource Optimization** – Reduce **storage costs** and **processing overhead** by eliminating redundant data operations.\n\nThe **Guepard API** allows developers, DevOps engineers, and data teams to **automate, integrate, and scale** their database workflows.\n\n---\n\n## **📌 Getting Started with the API**\n\n### 🔑 **Authentication**\n\nGuepard’s API requires authentication via **API Keys (wip)** or **JWT tokens**.\n\nTo authenticate requests, include the following header:\n\n```\nhttpCopyEditAuthorization: Bearer YOUR_API_KEY\n\n ```\n\n---\n\n## **🔗 API Capabilities**\n\nGuepard’s API provides endpoints to **provision, manage, and control** data environments. Key functionalities include:\n\n### 📍 **1\\. Environment & Database Management**\n\n- **Provision a new database instance**\n    \n- **Clone an existing database for testing or development**\n    \n- **List, update, and delete databases**\n    \n- **Pause/resume databases to optimize resources**\n    \n\n### 🔄 **2\\. Data Branching & Versioning**\n\n- **Create isolated database branches** for different environments (dev, test, staging, production)\n    \n- **Snapshot and rollback** to previous versions\n    \n- **Synchronize data across multiple Guepard instances**\n    \n\n### 🛠 **3\\. Infrastructure & Integrations**\n\n- **Monitor consumption & performance**\n    \n- **Manage encryption, access controls, and compliance**\n    \n- **CI/CD compatibility** to integrate Guepard into DevOps workflows\n    \n\nGuepard is built for **enterprises 🏢, AI-driven platforms 🤖, and DevOps teams 💻** looking for a **faster, smarter, and more efficient** way to work with data. **Unleash the power of instant data environments today!** 🚀\n\n---\n\n## Overview\n\nThe Guepard API simplifies the process of getting data in and out of the Guepard Core System (GCS). Using user-friendly resource-oriented URLs and clear status codes, the API communicates success or failure of requests, always returning data in JSON format. This guide makes it easy to grasp by demonstrating how to use Postman, a user-friendly tool, for essential API actions like `GET`, `POST`, `PUT`, and `DELETE` within the Guepard system.\n\n## Prerequisites\n\n- Activate your Guepard API and get your application keys (wip), actually using JWT.\n    \n- you have basic knowledge of API structure and JSON formatting.\n    \n- A free Postman account.\n    \n\n## Setup\n\n### Import the Guepard Collection into Postman\n\n- Download Postman Application\n    \n- Login to your Postman account\n    \n- Create or use a workspace\n    \n- import Guepard Collection into your workspace\n    \n\nVersion - 0.4.4-public","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"3839699","team":5809715,"collectionId":"bf2bd69c-397f-4d9c-b7c8-88efe5dd7c4d","publishedId":"2sB3HtGHNh","public":true,"publicUrl":"https://postman.guepard.run","privateUrl":"https://go.postman.co/documentation/3839699-bf2bd69c-397f-4d9c-b7c8-88efe5dd7c4d","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2025-09-22T10:01:02.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"0.4.4-public","id":"02caa34e-a51a-4564-b7aa-df1af711d229","owner":"3839699","values":[{"key":"base_url","value":"https://api.guepard.run","enabled":true,"type":"default","description":"Base URL for the Guepard API"},{"key":"access_token","value":"","enabled":true,"type":"default","description":"JWT access token (get from /auth/login)"},{"key":"deployment_id","value":"","enabled":true,"type":"default","description":"Sample deployment ID for testing"},{"key":"branch_id","value":"","enabled":true,"type":"default","description":"Sample branch ID for testing"},{"key":"snapshot_id","value":"","enabled":true,"type":"default","description":"Sample snapshot ID for testing"},{"key":"compute_id","value":"","enabled":true,"type":"default","description":"Sample compute ID for testing"},{"key":"performance_id","value":"","enabled":true,"type":"default","description":"Sample performance ID for testing"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/c5e982c7b1bb826f4ee92fbf041b52808a4431c6ab1e3735152336bfad9020bc","favicon":"https://res.cloudinary.com/postman/image/upload/v1742673186/team/c822a85d5627a823c931dcacd48a9c31.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"0.4.4-public","value":"3839699-02caa34e-a51a-4564-b7aa-df1af711d229"}],"canonicalUrl":"https://postman.guepard.run/view/metadata/2sB3HtGHNh"}