1. Home
2. Cloud

Confluent Cloud APIs

• Confluent Cloud APIs
• Cluster Management with Kafka REST API
  • Using Base64 Encoded Data and Credentials
  • Use cases
  • Supported Operations
    • Cluster Administration
    • Producing to a Kafka Topic
      • 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
  • Suggested Resources
• Metrics API
• Stream Catalog REST API
  • Catalog API Usage Examples
    • Setup and Suggestions
    • OAuth for Confluent Cloud Stream Catalog REST API
    • Entity types
    • Searching
    • Topics API Examples
      • List all topics
      • Search for topics by name
      • Search for topics by tag
      • Tag a topic
      • Create a tag for a topic
      • Working with topics and business metadata
    • 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 a schema given a subject version
      • Delete a tag
    • 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
      • 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
  • Suggested Reading
• 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
  • Suggested Reading
• 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 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 Kafka 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 Kafka cluster
    • Max private links per Kafka cluster
• 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