प्रौद्योगिकी साझेदारों के लिए Cato API संदर्भ

Cato API का परिचय

Cato API Cato SASE प्लेटफॉर्म पर डेटा और प्रबंधन कार्यों के साथ बातचीत के लिए प्राथमिक ऑटोमेशन इंटरफेस है। यह ग्राफक्यूएल का उपयोग लचीली क्वेरी और कुशल डेटा पुनर्प्राप्ति के लिए करता है, जिससे दोनों को सक्षम किया जा सके:

केवल पढ़ने के ऑपरेशंस (डेटा निष्कर्षण)
म्यूटेशन ऑपरेशंस (कॉन्फ़िगरेशन परिवर्तन)

विस्तृत स्कीमा संदर्भ के लिए, Cato API प्रलेखन देखें: https://api.catonetworks.com/documentation/

API एंडपॉइंट प्रारूप में होता है: https://api.catonetworks.com/api/v1/graphql2

API जीवनचक्र

API जीवनचक्र और उपयोग दिशा-निर्देशों का पूरा अवलोकन करने के लिए, देखें Cato API क्या है

कैसे उपयोग करें Cato API कुंजी

Cato API के लिए अनुरोधों को प्रमाणित करने के लिए, अपने API ग्राहक में x-api-key नामक एक HTTP शीर्षलेख शामिल करें। इस हेडर का मान अपनी Cato API कुंजी के लिए इस प्रारूप में सेट करें: x-api-key: <api-key>. उदाहरण के लिए: x-api-key: abcdef12345. यह शीर्षलेख आपके अनुरोध को प्राधिकृत करता है और आपके कुंजी से संबंधित अनुमतियों के आधार पर प्रासंगिक Cato API एंडप्वाइंट्स तक पहुंच प्रदान करता है।

एकीकरण स्कोपिंग दस्तावेज़ की Cato द्वारा अनुमोदित होने के बाद, API कुंजियाँ और सैंडबॉक्स वातावरण प्रदान किए जाएंगे

स्कीमा परिवर्तन

संभावित परिवर्तन के लिए Cato की SLA, "घोषणा और प्रबंधन संभावित परिवर्तन" सेक्शन में "Cato API क्या है" लेख में दर्ज की गई है.

API और फील्ड्स, जिन्हें लाइफ के अंत (EoL) के लिए योजना बनाई गई है, API दस्तावेज़ में उपयोग के योग्य नहीं के रूप में चिन्हित किए गए हैं. अनुपलब्ध होने पर, एक अनुशंसित प्रतिस्थापन और अनुसूचित EoL तारीख प्रदान की जाती है.

इसके अलावा, संभावित तोड़फोड़ परिवर्तन Cato API संभावित तोड़फोड़ परिवर्तन और EoL लेख में संप्रेषित किए जाते हैं। प्रौद्योगिकी साझेदारों को आगामी स्कीमा अपडेट्स और उपयोग न करने के संबंध में सूचनाएं प्राप्त करने के लिए इस लेख का अनुसरण करने के लिए प्रोत्साहित किया जाता है।

रेट लिमिटिंग और निष्पक्ष उपयोग

रेट लिमिटिंग नीति प्रत्येक खाते के लिए अनुमत अधिकतम अनुरोध थ्रूपुट को परिभाषित करती है और प्लेटफॉर्म स्थिरता और संसाधनों का निष्पक्ष उपयोग सुनिश्चित करने के लिए डिज़ाइन की गई है। एकीकरण को रेट लिमिट प्रतिक्रिया को संभालने के लिए उचित पुनः प्रयास और बैकऑफ तंत्र को लागू करना चाहिए। विवरण के लिए Cato API रेट लिमिटिंग को समझना लेख देखें।

इंटीग्रेशन के लिए कोर API एंडपॉइंट्स

नीचे प्रारंभिक एकीकरण और डेटा संक्रमण के दौरान उपयोग किए जाने वाले सबसे सामान्य API दिए गए हैं:

डेटा प्रकार	एपीआई	उद्देश्य	विशिष्ट उपयोग मामले
कच्चे घटनाक्रम / सुरक्षा टेलीमेट्री	eventsFeed	कच्चे ईवेंट लॉग और सुरक्षा टेलीमेट्री का उपभोग करने के लिए अनुशंसित प्रवेश बिंदु।	SIEM संक्रमण, सुरक्षा निगरानी, अनुपालन लॉगिंग, खतरे की पहचान।
प्रशासनिक ऑडिट लॉग्स	auditFeed	व्यवस्थापक क्रियाओं और कॉन्फ़िगरेशन परिवर्तनों के लिए ऑडिट लॉग पुनः प्राप्त करता है।	अनुपालन ऑडिटिंग, परिवर्तन ट्रैकिंग, शासन निगरानी।
अनुप्रयोग और प्रवाह विश्लेषण	appStats appStatsTimeSeries	अनुप्रयोग उपयोग सांख्यिकी और प्रवाह प्रदर्शन मीट्रिक्स समय के साथ प्रदान करता है।	एप्लिकेशन मॉनिटरिंग, नेटवर्क प्रदर्शन विश्लेषण, उपयोग रिपोर्टिंग।
सुरक्षा घटनाएँ / अलर्ट्स	कहानियाँ	सुरक्षा घटनाओं और संबंधित अलर्ट्स में उच्च स्तरीय अंतर्दृष्टि।	SOC वर्कफ़्लो, घटना प्रबंधन, अलर्ट संवर्द्धन।
ट्रैफ़िक मीट्रिक्स	accountMetrics	साइट्स और दूरस्थ उपयोगकर्ताओं के बीच ट्रैफ़िक और उपयोग मीट्रिक्स।	नेटवर्क उपयोग विश्लेषण, क्षमता योजना, और रिपोर्टिंग डैशबोर्ड।
कनेक्टिविटी और इन्वेंटरी स्नैपशॉट	accountSnapshot	साइट्स, सॉकेट्स, और उपयोगकर्ताओं के लिए कनेक्टिविटी स्थिति और सूची जानकारी।	इन्फ्रास्ट्रक्चर निगरानी, टोपोलॉजी दृश्यता, और वातावरण की खोज।
उपकरण इन्वेंटरी और विशेषताएँ	devices.attributesCatalog devices.list	प्लेटफ़ॉर्म द्वारा खोजे गए उपकरण सूची और संबंधित विशेषताएँ प्रदान करता है।	संपत्ति प्रबंधन प्रणाली, IoT/OT दृश्यता, उपकरण वर्गीकरण, और सूची ट्रैकिंग।
सॉकेट पोर्ट मीट्रिक्स	socketPortMetrics socketPortMetricsTimeSeries	सॉकेट इंटरफेस और पोर्ट्स के लिए वर्तमान और ऐतिहासिक मीट्रिक्स प्रदान करता है।	इन्फ्रास्ट्रक्चर निगरानी, लिंक स्वास्थ्य निगरानी, क्षमता योजना, और नेटवर्क समस्या निवारण।

पूरी API संचालन परिभाषाएँ और नमूना प्रतिक्रियाओं के लिए, Cato GraphQL API संदर्भ देखें।

संदर्भ उपकरण और उदाहरण

विकास और एकीकरण वर्कफ़्लो का समर्थन करने के लिए, Cato कई संदर्भ संसाधन प्रदान करता है:

Cato GitHub खाता - नमूना कोड, एपीआई सहायक उपकरण, Jupyter नोटबुक्स, पोस्टमैन संग्रह, और CLI उपयोगिताएं। उदाहरण:
डेटा-विश्लेषण - इवेंटफीड उपयोग मामलों को प्रदर्शित करने वाले Jupyter नोटबुक्स।
cato-toolbox - एपीआई उपभोग और परीक्षण के लिए सामान्य-उद्देश्य सहायक, जिसमें ईवेंट प्राप्त करने के लिए पायथन कोड शामिल है।
GraphQL प्लेग्राउंड - एपीआई क्वेरी परीक्षण के लिए ब्राउज़र-आधारित इंटरैक्टिव टूल। विवरण के लिए, GraphQL प्लेग्राउंड से Cato API देखें।
Cato Remote MCP सर्वर - मॉडल संदर्भ प्रोटोकॉल (MCP) के माध्यम से AI सहायक और LLM-आधारित उपकरणों का उपयोग करके Cato API के साथ एकीकरण को सक्षम बनाता है। यह प्राकृतिक भाषा या AI-संचालित वर्कफ़्लो का उपयोग करके Cato डेटा के साथ बातचीत करने की अनुमति देता है। अधिक जानकारी के लिए, देखें: Cato Remote MCP सर्वर के साथ कार्य करना।

समर्थन और सामुदायिक संसाधन

साझेदार API संबंधित प्रश्नों को उठाने के माध्यम से कर सकते हैं