Version: 5.1
On this page
APIs you call from an integration, and the APIs of the Integration Control Plane.
Integration Control Plane APIs
Ballerina language and libraries
Ballerina API documentation
Complete API documentation for all Ballerina standard library modules and extended modules is published on Ballerina Central . This page provides a categorized index of the most important modules used in integration development.
Standard library modules
Network - protocol modules
Module Description API Docs ballerina/httpHTTP client and service with HTTP/1.1 and HTTP/2 support API Docs ballerina/grpcgRPC client and service support API Docs ballerina/graphqlGraphQL service and client support API Docs ballerina/websocketWebSocket client and service support API Docs ballerina/websubWebSub hub, publisher, and subscriber API Docs ballerina/websubhubWebSub hub implementation API Docs ballerina/tcpTCP client and listener API Docs ballerina/udpUDP client and listener API Docs ballerina/ftpFTP client and listener API Docs ballerina/emailSMTP, POP3, and IMAP email support API Docs
Network - messaging modules
Module Description API Docs ballerinax/kafkaApache Kafka producer and consumer API Docs ballerinax/rabbitmqRabbitMQ client and listener API Docs ballerinax/natsNATS client and listener API Docs ballerinax/stanNATS Streaming (STAN) client API Docs ballerinax/java.jmsJMS client support API Docs ballerinax/mqttMQTT client and listener API Docs ballerinax/asbAzure Service Bus client API Docs
Database modules
Module Description API Docs ballerina/sqlGeneric SQL client abstraction API Docs ballerinax/mysqlMySQL database client API Docs ballerinax/postgresqlPostgreSQL database client API Docs ballerinax/mssqlMicrosoft SQL Server client API Docs ballerinax/oracledbOracle Database client API Docs ballerina/persistData persistence layer API Docs
Data handling modules
Module Description API Docs ballerina/ioFile and stream I/O operations API Docs ballerina/xmldataXML data processing utilities API Docs ballerina/constraintData validation constraints API Docs ballerina/regexRegular expression support API Docs ballerina/mimeMIME type handling API Docs ballerina/urlURL encoding and decoding API Docs ballerina/data.jsondataJSON data processing API Docs ballerina/data.xmldataXML data binding API Docs ballerina/data.csvCSV data processing API Docs ballerinax/health.hl7v2HL7 v2 message processing API Docs ballerinax/health.fhir.r4FHIR R4 resource types API Docs
Security modules
Module Description API Docs ballerina/authAuthentication framework API Docs ballerina/jwtJWT token handling API Docs ballerina/oauth2OAuth 2.0 client support API Docs ballerina/cryptoCryptographic operations API Docs
Utility modules
Module Description API Docs ballerina/logLogging framework API Docs ballerina/timeDate, time, and timezone operations API Docs ballerina/uuidUUID generation API Docs ballerina/cacheIn-memory caching API Docs ballerina/taskTask scheduling (cron, timers) API Docs ballerina/fileFile system operations API Docs ballerina/osOperating system utilities API Docs ballerina/lang.runtimeRuntime management API Docs
Observability modules
Module Description API Docs ballerina/observeObservability and tracing API Docs ballerinax/prometheusPrometheus metrics API Docs ballerinax/jaegerJaeger distributed tracing API Docs
Cloud and SaaS connector modules
Module Description API Docs ballerinax/salesforceSalesforce CRM client API Docs ballerinax/githubGitHub API client API Docs ballerinax/googleapis.sheetsGoogle Sheets client API Docs ballerinax/googleapis.gmailGmail client API Docs ballerinax/slackSlack messaging client API Docs ballerinax/twilioTwilio messaging and voice API Docs ballerinax/aws.s3AWS S3 object storage API Docs ballerinax/aws.sqsAWS SQS messaging API Docs ballerinax/azure.functionsAzure Functions integration API Docs
AI and LLM modules
Module Description API Docs ballerinax/ai.agentAI agent framework API Docs ballerinax/openai.chatOpenAI Chat API client API Docs ballerinax/openai.embeddingsOpenAI Embeddings API client API Docs ballerinax/azure.openaiAzure OpenAI client API Docs
Browsing API docs
On Ballerina central
Go to central.ballerina.io
Use the search bar to find a module by name or keyword
Filter by organization (ballerina for standard library, ballerinax for extended modules)
Select a module to view its API documentation, including types, functions, classes, and examples
In VS code
The WSO2 Integrator VS Code extension provides inline API documentation:
Hover over a module import to see the module description
Use Ctrl+Click (or Cmd+Click on macOS) on a function or type to navigate to its definition
Use the command palette (Ctrl+Shift+P) and search for "Ballerina: Show API Docs"
See also