Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Redpanda Provider
  4. API Docs
  5. getSchema
Viewing docs for redpanda 2.0.0
published on Wednesday, Jun 3, 2026 by redpanda-data
Schema (JSON)
redpanda-data/terraform-provider-redpanda

redpanda.getSchema

Viewing docs for redpanda 2.0.0
published on Wednesday, Jun 3, 2026 by redpanda-data
Schema (JSON)
redpanda-data/terraform-provider-redpanda

    Schema data source allows you to retrieve information about a Schema Registry schema

    Usage

    import * as pulumi from "@pulumi/pulumi";
import * as redpanda from "@pulumi/redpanda";

const example = redpanda.getSchema({
    clusterId: "cluster_id",
    subject: "my-subject",
});

    import pulumi
import pulumi_redpanda as redpanda

example = redpanda.get_schema(cluster_id="cluster_id",
    subject="my-subject")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/redpanda/v2/redpanda"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := redpanda.LookupSchema(ctx, &redpanda.LookupSchemaArgs{
			ClusterId: "cluster_id",
			Subject:   "my-subject",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Redpanda = Pulumi.Redpanda;

return await Deployment.RunAsync(() => 
{
    var example = Redpanda.GetSchema.Invoke(new()
    {
        ClusterId = "cluster_id",
        Subject = "my-subject",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.redpanda.RedpandaFunctions;
import com.pulumi.redpanda.inputs.GetSchemaArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = RedpandaFunctions.getSchema(GetSchemaArgs.builder()
            .clusterId("cluster_id")
            .subject("my-subject")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: redpanda:getSchema
      arguments:
        clusterId: cluster_id
        subject: my-subject

    Example coming soon!

    import * as pulumi from "@pulumi/pulumi";
import * as redpanda from "@pulumi/redpanda";

// Bearer auth (default): omit username and password
const example = redpanda.getSchema({
    clusterId: clusterId,
    subject: subject,
});

    import pulumi
import pulumi_redpanda as redpanda

# Bearer auth (default): omit username and password
example = redpanda.get_schema(cluster_id=cluster_id,
    subject=subject)

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/redpanda/v2/redpanda"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Bearer auth (default): omit username and password
		_, err := redpanda.LookupSchema(ctx, &redpanda.LookupSchemaArgs{
			ClusterId: clusterId,
			Subject:   subject,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Redpanda = Pulumi.Redpanda;

return await Deployment.RunAsync(() => 
{
    // Bearer auth (default): omit username and password
    var example = Redpanda.GetSchema.Invoke(new()
    {
        ClusterId = clusterId,
        Subject = subject,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.redpanda.RedpandaFunctions;
import com.pulumi.redpanda.inputs.GetSchemaArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        // Bearer auth (default): omit username and password
        final var example = RedpandaFunctions.getSchema(GetSchemaArgs.builder()
            .clusterId(clusterId)
            .subject(subject)
            .build());

    }
}

    variables:
  # Bearer auth (default): omit username and password
  example:
    fn::invoke:
      function: redpanda:getSchema
      arguments:
        clusterId: ${clusterId}
        subject: ${subject}

    Example coming soon!

    Using getSchema

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getSchema(args: GetSchemaArgs, opts?: InvokeOptions): Promise<GetSchemaResult>
function getSchemaOutput(args: GetSchemaOutputArgs, opts?: InvokeOptions): Output<GetSchemaResult>
    def get_schema(cluster_id: Optional[str] = None,
               password: Optional[str] = None,
               subject: Optional[str] = None,
               username: Optional[str] = None,
               version: Optional[float] = None,
               opts: Optional[InvokeOptions] = None) -> GetSchemaResult
def get_schema_output(cluster_id: pulumi.Input[Optional[str]] = None,
               password: pulumi.Input[Optional[str]] = None,
               subject: pulumi.Input[Optional[str]] = None,
               username: pulumi.Input[Optional[str]] = None,
               version: pulumi.Input[Optional[float]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetSchemaResult]
    func LookupSchema(ctx *Context, args *LookupSchemaArgs, opts ...InvokeOption) (*LookupSchemaResult, error)
func LookupSchemaOutput(ctx *Context, args *LookupSchemaOutputArgs, opts ...InvokeOption) LookupSchemaResultOutput

    > Note: This function is named LookupSchema in the Go SDK.

    public static class GetSchema 
{
    public static Task<GetSchemaResult> InvokeAsync(GetSchemaArgs args, InvokeOptions? opts = null)
    public static Output<GetSchemaResult> Invoke(GetSchemaInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSchemaResult> getSchema(GetSchemaArgs args, InvokeOptions options)
public static Output<GetSchemaResult> getSchema(GetSchemaArgs args, InvokeOptions options)

    fn::invoke:
  function: redpanda:index/getSchema:getSchema
  arguments:
    # arguments dictionary
    data "redpanda_getschema" "name" {
    # arguments
}

    The following arguments are supported:

    ClusterId string
    The ID of the cluster where the schema is stored.
    Subject string
    The subject name for the schema.
    Password string
    SASL password for Schema Registry HTTP Basic authentication. Pair with username when Basic auth is required instead of the cloud Bearer token.
    Username string
    SASL username for Schema Registry HTTP Basic authentication. Optional: when omitted (together with password) the provider authenticates using its cloud Bearer token.
    Version double
    The version of the schema. If not specified, the latest version is used.
    ClusterId string
    The ID of the cluster where the schema is stored.
    Subject string
    The subject name for the schema.
    Password string
    SASL password for Schema Registry HTTP Basic authentication. Pair with username when Basic auth is required instead of the cloud Bearer token.
    Username string
    SASL username for Schema Registry HTTP Basic authentication. Optional: when omitted (together with password) the provider authenticates using its cloud Bearer token.
    Version float64
    The version of the schema. If not specified, the latest version is used.
    cluster_id string
    The ID of the cluster where the schema is stored.
    subject string
    The subject name for the schema.
    password string
    SASL password for Schema Registry HTTP Basic authentication. Pair with username when Basic auth is required instead of the cloud Bearer token.
    username string
    SASL username for Schema Registry HTTP Basic authentication. Optional: when omitted (together with password) the provider authenticates using its cloud Bearer token.
    version number
    The version of the schema. If not specified, the latest version is used.
    clusterId String
    The ID of the cluster where the schema is stored.
    subject String
    The subject name for the schema.
    password String
    SASL password for Schema Registry HTTP Basic authentication. Pair with username when Basic auth is required instead of the cloud Bearer token.
    username String
    SASL username for Schema Registry HTTP Basic authentication. Optional: when omitted (together with password) the provider authenticates using its cloud Bearer token.
    version Double
    The version of the schema. If not specified, the latest version is used.
    clusterId string
    The ID of the cluster where the schema is stored.
    subject string
    The subject name for the schema.
    password string
    SASL password for Schema Registry HTTP Basic authentication. Pair with username when Basic auth is required instead of the cloud Bearer token.
    username string
    SASL username for Schema Registry HTTP Basic authentication. Optional: when omitted (together with password) the provider authenticates using its cloud Bearer token.
    version number
    The version of the schema. If not specified, the latest version is used.
    cluster_id str
    The ID of the cluster where the schema is stored.
    subject str
    The subject name for the schema.
    password str
    SASL password for Schema Registry HTTP Basic authentication. Pair with username when Basic auth is required instead of the cloud Bearer token.
    username str
    SASL username for Schema Registry HTTP Basic authentication. Optional: when omitted (together with password) the provider authenticates using its cloud Bearer token.
    version float
    The version of the schema. If not specified, the latest version is used.
    clusterId String
    The ID of the cluster where the schema is stored.
    subject String
    The subject name for the schema.
    password String
    SASL password for Schema Registry HTTP Basic authentication. Pair with username when Basic auth is required instead of the cloud Bearer token.
    username String
    SASL username for Schema Registry HTTP Basic authentication. Optional: when omitted (together with password) the provider authenticates using its cloud Bearer token.
    version Number
    The version of the schema. If not specified, the latest version is used.

    getSchema Result

    The following output properties are available:

    ClusterId string
    The ID of the cluster where the schema is stored.
    Id double
    The unique identifier for the schema.
    References List<GetSchemaReference>
    List of schema references.
    Schema string
    The schema definition in JSON format.
    SchemaType string
    The type of schema (AVRO, JSON, PROTOBUF).
    Subject string
    The subject name for the schema.
    Version double
    The version of the schema. If not specified, the latest version is used.
    Password string
    SASL password for Schema Registry HTTP Basic authentication. Pair with username when Basic auth is required instead of the cloud Bearer token.
    Username string
    SASL username for Schema Registry HTTP Basic authentication. Optional: when omitted (together with password) the provider authenticates using its cloud Bearer token.
    ClusterId string
    The ID of the cluster where the schema is stored.
    Id float64
    The unique identifier for the schema.
    References []GetSchemaReference
    List of schema references.
    Schema string
    The schema definition in JSON format.
    SchemaType string
    The type of schema (AVRO, JSON, PROTOBUF).
    Subject string
    The subject name for the schema.
    Version float64
    The version of the schema. If not specified, the latest version is used.
    Password string
    SASL password for Schema Registry HTTP Basic authentication. Pair with username when Basic auth is required instead of the cloud Bearer token.
    Username string
    SASL username for Schema Registry HTTP Basic authentication. Optional: when omitted (together with password) the provider authenticates using its cloud Bearer token.
    cluster_id string
    The ID of the cluster where the schema is stored.
    id number
    The unique identifier for the schema.
    references list(object)
    List of schema references.
    schema string
    The schema definition in JSON format.
    schema_type string
    The type of schema (AVRO, JSON, PROTOBUF).
    subject string
    The subject name for the schema.
    version number
    The version of the schema. If not specified, the latest version is used.
    password string
    SASL password for Schema Registry HTTP Basic authentication. Pair with username when Basic auth is required instead of the cloud Bearer token.
    username string
    SASL username for Schema Registry HTTP Basic authentication. Optional: when omitted (together with password) the provider authenticates using its cloud Bearer token.
    clusterId String
    The ID of the cluster where the schema is stored.
    id Double
    The unique identifier for the schema.
    references List<GetSchemaReference>
    List of schema references.
    schema String
    The schema definition in JSON format.
    schemaType String
    The type of schema (AVRO, JSON, PROTOBUF).
    subject String
    The subject name for the schema.
    version Double
    The version of the schema. If not specified, the latest version is used.
    password String
    SASL password for Schema Registry HTTP Basic authentication. Pair with username when Basic auth is required instead of the cloud Bearer token.
    username String
    SASL username for Schema Registry HTTP Basic authentication. Optional: when omitted (together with password) the provider authenticates using its cloud Bearer token.
    clusterId string
    The ID of the cluster where the schema is stored.
    id number
    The unique identifier for the schema.
    references GetSchemaReference[]
    List of schema references.
    schema string
    The schema definition in JSON format.
    schemaType string
    The type of schema (AVRO, JSON, PROTOBUF).
    subject string
    The subject name for the schema.
    version number
    The version of the schema. If not specified, the latest version is used.
    password string
    SASL password for Schema Registry HTTP Basic authentication. Pair with username when Basic auth is required instead of the cloud Bearer token.
    username string
    SASL username for Schema Registry HTTP Basic authentication. Optional: when omitted (together with password) the provider authenticates using its cloud Bearer token.
    cluster_id str
    The ID of the cluster where the schema is stored.
    id float
    The unique identifier for the schema.
    references Sequence[GetSchemaReference]
    List of schema references.
    schema str
    The schema definition in JSON format.
    schema_type str
    The type of schema (AVRO, JSON, PROTOBUF).
    subject str
    The subject name for the schema.
    version float
    The version of the schema. If not specified, the latest version is used.
    password str
    SASL password for Schema Registry HTTP Basic authentication. Pair with username when Basic auth is required instead of the cloud Bearer token.
    username str
    SASL username for Schema Registry HTTP Basic authentication. Optional: when omitted (together with password) the provider authenticates using its cloud Bearer token.
    clusterId String
    The ID of the cluster where the schema is stored.
    id Number
    The unique identifier for the schema.
    references List<Property Map>
    List of schema references.
    schema String
    The schema definition in JSON format.
    schemaType String
    The type of schema (AVRO, JSON, PROTOBUF).
    subject String
    The subject name for the schema.
    version Number
    The version of the schema. If not specified, the latest version is used.
    password String
    SASL password for Schema Registry HTTP Basic authentication. Pair with username when Basic auth is required instead of the cloud Bearer token.
    username String
    SASL username for Schema Registry HTTP Basic authentication. Optional: when omitted (together with password) the provider authenticates using its cloud Bearer token.

    Supporting Types

    GetSchemaReference

    Name string
    The name of the referenced schema.
    Subject string
    The subject of the referenced schema.
    Version double
    The version of the referenced schema.
    Name string
    The name of the referenced schema.
    Subject string
    The subject of the referenced schema.
    Version float64
    The version of the referenced schema.
    name string
    The name of the referenced schema.
    subject string
    The subject of the referenced schema.
    version number
    The version of the referenced schema.
    name String
    The name of the referenced schema.
    subject String
    The subject of the referenced schema.
    version Double
    The version of the referenced schema.
    name string
    The name of the referenced schema.
    subject string
    The subject of the referenced schema.
    version number
    The version of the referenced schema.
    name str
    The name of the referenced schema.
    subject str
    The subject of the referenced schema.
    version float
    The version of the referenced schema.
    name String
    The name of the referenced schema.
    subject String
    The subject of the referenced schema.
    version Number
    The version of the referenced schema.

    Package Details

    Repository
    redpanda redpanda-data/terraform-provider-redpanda
    License
    Notes
    This Pulumi package is based on the redpanda Terraform Provider.
    Viewing docs for redpanda 2.0.0
    published on Wednesday, Jun 3, 2026 by redpanda-data
    Schema (JSON)
    redpanda-data/terraform-provider-redpanda

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial