API Reference for Confluent Cloud

• Confluent Cloud APIs
• Kafka Admin and Produce REST APIs
  • Using Base64 Encoded Data and Credentials
  • Use cases
  • Cluster Admin API
    • Principal IDs for ACLs
  • Produce API
    • Streaming mode (recommended)
    • Non-streaming mode (not recommended)
    • Producing a single record to a topic
    • Producing a batch of records to a topic
    • Data payload specification
  • Connection bias and request limits
  • Suggested Resources
• Connect API
  • Prerequisites
  • Managed and Custom Connector API Examples
    • Get a list of connectors
    • Create a connector
      • Custom connector configuration payload
      • Raw JSON payload example
      • JSON file payload example
    • Update (or create) a connector
    • Read a connector configuration
    • Query a sink connector for metrics
    • Delete a connector
  • Fully-Managed and Custom Connector Plugin API Examples
    • Fully-managed connector plugin examples
      • List fully-managed plugins
      • Validate a fully-managed plugin
    • Custom connector plugin examples
      • List custom plugins
      • Request a presigned URL
      • Upload a custom plugin
      • Create a custom plugin
      • Read a custom plugin
      • Update a custom plugin
      • Delete a custom plugin
  • Next Steps
• Flink REST API
  • Prerequisites
  • Generate a Flink API key
  • Manage statements
    • Flink SQL statement schema
    • Submit a statement
    • Get a statement
    • List statements
    • Update metadata for a statement
    • Delete a statement
  • Manage compute pools
    • List Flink compute pools
    • Create a Flink compute pool
    • Read a Flink compute pool
    • Update a Flink compute pool
    • Delete a Flink compute pool
  • List Flink regions
  • Related content
• Metrics API
• Stream Catalog REST API Usage
  • Catalog API usage examples
    • Setup and suggestions
    • OAuth for Confluent Cloud Stream Catalog REST API
    • Entity types
      • How entities are identified
      • Qualified name definitions
        • Examples of qualified names
      • Entity APIs
    • Searching
    • Tags API examples
      • Create a tag
        • Create a generic tag applicable to a topic or any entity
        • Create a tag applicable to only specific entities
      • Update a tag by adding attributes (key, value pairs)
      • List all tags (with definitions)
      • Get tag definition
      • Search fields by name
      • Search fields by tag
      • Search schema record by name
      • Search schema by tag
      • Tag a field in Avro
      • Get the tag attributes from a field
      • Tag a schema version
      • Get schemas with a given a subject name prefix
      • Delete a tag
      • Topics
        • List all topics
        • Search for topics by name
        • Search for topics by tag
        • Tag a topic
        • Add a topic owner and email
        • Create a tag for a topic
      • Connectors
        • List all connectors
        • Search for connectors by name
        • Tag a connector
    • Business metadata API examples
      • Create a schema
      • Create your first business metadata definition
      • Create a business metadata definition for a topic
      • Get all the business metadata definitions created so far
      • Get a specific business metadata definition by its name
      • Update business metadata definitions
      • Add business metadata to a schema-related entity
      • Add business metadata to a topic
      • Add business metadata to a connector
      • Get business metadata associated with an instance of an entity
      • Update business metadata associated with entity
      • Search for business metadata associated with entity
      • Remove business metadata associated with an entity
      • Delete business metadata definitions
  • Related content
• GraphQL API
  • Overview
    • What is it?
    • Why is it important?
    • When to use REST API and when to use GraphQL API
  • Getting started
    • GraphQL endpoint
    • GraphQL schema
    • Entity queries
      • Fetch list of entities
      • Fetch nested entities using relationships
      • Filtering using the “where” argument
      • Sort Using the “order_by” Argument
      • Pagination with the “limit” and “offset” Arguments
      • Filtering by tag with the “tags” argument
      • Including deleted objects with the “deleted” argument
    • API limits
      • Query limits
      • Time limits
      • Rate limits
  • API reference
  • Related content
• Service Quotas API
  • Get a Cloud API key and secret
  • Service Quotas API endpoints
  • Query a Service Quotas endpoint
    • Paged responses
    • RBAC Model
  • Example requests
  • Filtering
  • Query for scopes
  • Organization quotas
    • Max BYOK keys per organization
    • Max Cloud API keys for an organization
    • Max environments for an organization
    • Max Kafka clusters for an organization
    • Max service accounts for an organization
    • Max user accounts for an organization
    • Max pending invitations for an organization
    • Max audit log consumer API keys per organization
    • Max Kafka cluster provisioning requests per day
  • Service account quotas
    • Max Cloud API keys per service account
    • Max Kafka API keys per service account
  • User account quotas
    • Max Cloud API keys per user
    • Max Cluster API keys per user
  • Environment quotas
    • Get your environment ID
    • Max clusters for an environment
    • Max cluster CKUs for an environment
    • Max pending clusters for an environment
    • Max ksqlDB clusters for an environment
  • Kafka cluster quotas
    • Get the Kafka cluster ID
    • Max API keys per Kafka cluster
    • Max private links per Kafka cluster
    • Max peering connections per Kafka cluster
    • Max CKUs per Kafka cluster
  • Network quotas
    • Max peering connections per network
    • Max private link connections per network
• Stream Designer Pipelines API
  • Prequisites for using the Pipelines REST API
  • Get an authentication token
  • Get the environment and Kafka cluster IDs
  • Create a pipeline
  • Get a pipeline ID
  • View pipeline details
  • Save a pipeline to a description file
  • Update a pipeline’s metadata
  • Patch a pipeline’s metadata
  • Grant activation privileges
  • Revoke pipeline privileges
  • Activate or deactivate a pipeline
  • View pipeline source code
  • Suggested Resources