Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Avi Provider
  4. API Docs
  5. getApischema
Viewing docs for avi 32.1.4
published on Friday, Oct 23, 2026 by vmware
Schema (JSON)
vmware/terraform-provider-avi

avi.getApischema

avi
Viewing docs for avi 32.1.4
published on Friday, Oct 23, 2026 by vmware
Schema (JSON)
vmware/terraform-provider-avi

    <!–

    Copyright 2021 VMware, Inc.
SPDX-License-Identifier: Mozilla Public License 2.0

    –>

    layout: “avi”

    page_title: “AVI: avi.Apischema” sidebar_current: “docs-avi-datasource-apischema” description: |- Get information of Avi ApiSchema.

    avi.Apischema

    This data source is used to to get avi.Apischema objects.

    Example Usage

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

const fooApischema = avi.getApischema({
    uuid: "apischema-f9cf6b3e-a411-436f-95e2-2982ba2b217b",
    name: "foo",
});

    import pulumi
import pulumi_avi as avi

foo_apischema = avi.get_apischema(uuid="apischema-f9cf6b3e-a411-436f-95e2-2982ba2b217b",
    name="foo")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := avi.LookupApischema(ctx, &avi.LookupApischemaArgs{
			Uuid: pulumi.StringRef("apischema-f9cf6b3e-a411-436f-95e2-2982ba2b217b"),
			Name: pulumi.StringRef("foo"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var fooApischema = Avi.GetApischema.Invoke(new()
    {
        Uuid = "apischema-f9cf6b3e-a411-436f-95e2-2982ba2b217b",
        Name = "foo",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.avi.AviFunctions;
import com.pulumi.avi.inputs.GetApischemaArgs;
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 fooApischema = AviFunctions.getApischema(GetApischemaArgs.builder()
            .uuid("apischema-f9cf6b3e-a411-436f-95e2-2982ba2b217b")
            .name("foo")
            .build());

    }
}

    variables:
  fooApischema:
    fn::invoke:
      function: avi:getApischema
      arguments:
        uuid: apischema-f9cf6b3e-a411-436f-95e2-2982ba2b217b
        name: foo

    Example coming soon!

    Using getApischema

    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 getApischema(args: GetApischemaArgs, opts?: InvokeOptions): Promise<GetApischemaResult>
function getApischemaOutput(args: GetApischemaOutputArgs, opts?: InvokeOutputOptions): Output<GetApischemaResult>
    def get_apischema(id: Optional[str] = None,
                  name: Optional[str] = None,
                  tenant_ref: Optional[str] = None,
                  uuid: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetApischemaResult
def get_apischema_output(id: pulumi.Input[Optional[str]] = None,
                  name: pulumi.Input[Optional[str]] = None,
                  tenant_ref: pulumi.Input[Optional[str]] = None,
                  uuid: pulumi.Input[Optional[str]] = None,
                  opts: Optional[InvokeOutputOptions] = None) -> Output[GetApischemaResult]
    func LookupApischema(ctx *Context, args *LookupApischemaArgs, opts ...InvokeOption) (*LookupApischemaResult, error)
func LookupApischemaOutput(ctx *Context, args *LookupApischemaOutputArgs, opts ...InvokeOption) LookupApischemaResultOutput

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

    public static class GetApischema 
{
    public static Task<GetApischemaResult> InvokeAsync(GetApischemaArgs args, InvokeOptions? opts = null)
    public static Output<GetApischemaResult> Invoke(GetApischemaInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetApischemaResult> Invoke(GetApischemaInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetApischemaResult> getApischema(GetApischemaArgs args, InvokeOptions options)
public static Output<GetApischemaResult> getApischema(GetApischemaArgs args, InvokeOptions options)
public static Output<GetApischemaResult> getApischema(GetApischemaArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: avi:index/getApischema:getApischema
  arguments:
    # arguments dictionary
    data "avi_get_apischema" "name" {
    # arguments
}

    The following arguments are supported:

    Id string
    Name string
    Search ApiSchema by name.
    TenantRef string
    It is a reference to an object of type tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Uuid string
    Search ApiSchema by uuid.
    Id string
    Name string
    Search ApiSchema by name.
    TenantRef string
    It is a reference to an object of type tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Uuid string
    Search ApiSchema by uuid.
    id string
    name string
    Search ApiSchema by name.
    tenant_ref string
    It is a reference to an object of type tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid string
    Search ApiSchema by uuid.
    id String
    name String
    Search ApiSchema by name.
    tenantRef String
    It is a reference to an object of type tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid String
    Search ApiSchema by uuid.
    id string
    name string
    Search ApiSchema by name.
    tenantRef string
    It is a reference to an object of type tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid string
    Search ApiSchema by uuid.
    id str
    name str
    Search ApiSchema by name.
    tenant_ref str
    It is a reference to an object of type tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid str
    Search ApiSchema by uuid.
    id String
    name String
    Search ApiSchema by name.
    tenantRef String
    It is a reference to an object of type tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid String
    Search ApiSchema by uuid.

    getApischema Result

    The following output properties are available:

    AdditionalObjectKeyAction string
    Action to take on unspecified keys in an object. Enum options - API_ACTION_INHERIT_FROM_API_POLICY, API_ACTION_PASS, API_ACTION_FLAG, API_ACTION_REJECT. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    AdditionalPropertiesSchemas List<GetApischemaAdditionalPropertiesSchema>
    Type constraint for additional properties not defined in object_properties. When set, unknown keys must conform to this schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    AllowAdditionalProperties string
    When true, object keys not defined in object_properties are permitted. Corresponds to openapi additionalproperties true. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ArrayItemTypes List<GetApischemaArrayItemType>
    If the type is array, this is the type of the array items. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    CompositeTypes List<GetApischemaCompositeType>
    Sub-schemas for this composite type (oneof, anyof, or allof). Each entry must be a schema_type_reference pointing to an apischema. Field introduced in 32.1.4. Maximum of 64 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ConfigpbAttributes List<GetApischemaConfigpbAttribute>
    Protobuf versioning for config pbs. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Description string
    Description of this api schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Discriminators List<GetApischemaDiscriminator>
    Property used to distinguish between sub-schemas in oneof/anyof composite types. Maps a discriminator property value to the matching schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Id string
    MaxItems string
    Maximum number of items allowed in an array. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    MinItems string
    Minimum number of items allowed in an array. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Name string
    Name of this object, unique per tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ObjectProperties List<GetApischemaObjectProperty>
    List of properties for this object schema. Field introduced in 32.1.4. Maximum of 512 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Source string
    Indicates whether this schema was user-defined or imported from an openapi specification file. Enum options - SOURCE_USER_DEFINED, SOURCE_API_SPEC, SOURCE_DISCOVERED. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    TenantRef string
    It is a reference to an object of type tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Type string
    The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    UniqueItems string
    If true, all items in the array must be unique. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Uuid string
    The object uuid. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    AdditionalObjectKeyAction string
    Action to take on unspecified keys in an object. Enum options - API_ACTION_INHERIT_FROM_API_POLICY, API_ACTION_PASS, API_ACTION_FLAG, API_ACTION_REJECT. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    AdditionalPropertiesSchemas []GetApischemaAdditionalPropertiesSchema
    Type constraint for additional properties not defined in object_properties. When set, unknown keys must conform to this schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    AllowAdditionalProperties string
    When true, object keys not defined in object_properties are permitted. Corresponds to openapi additionalproperties true. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ArrayItemTypes []GetApischemaArrayItemType
    If the type is array, this is the type of the array items. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    CompositeTypes []GetApischemaCompositeType
    Sub-schemas for this composite type (oneof, anyof, or allof). Each entry must be a schema_type_reference pointing to an apischema. Field introduced in 32.1.4. Maximum of 64 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ConfigpbAttributes []GetApischemaConfigpbAttribute
    Protobuf versioning for config pbs. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Description string
    Description of this api schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Discriminators []GetApischemaDiscriminator
    Property used to distinguish between sub-schemas in oneof/anyof composite types. Maps a discriminator property value to the matching schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Id string
    MaxItems string
    Maximum number of items allowed in an array. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    MinItems string
    Minimum number of items allowed in an array. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Name string
    Name of this object, unique per tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ObjectProperties []GetApischemaObjectProperty
    List of properties for this object schema. Field introduced in 32.1.4. Maximum of 512 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Source string
    Indicates whether this schema was user-defined or imported from an openapi specification file. Enum options - SOURCE_USER_DEFINED, SOURCE_API_SPEC, SOURCE_DISCOVERED. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    TenantRef string
    It is a reference to an object of type tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Type string
    The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    UniqueItems string
    If true, all items in the array must be unique. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Uuid string
    The object uuid. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    additional_object_key_action string
    Action to take on unspecified keys in an object. Enum options - API_ACTION_INHERIT_FROM_API_POLICY, API_ACTION_PASS, API_ACTION_FLAG, API_ACTION_REJECT. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    additional_properties_schemas list(object)
    Type constraint for additional properties not defined in object_properties. When set, unknown keys must conform to this schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    allow_additional_properties string
    When true, object keys not defined in object_properties are permitted. Corresponds to openapi additionalproperties true. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    array_item_types list(object)
    If the type is array, this is the type of the array items. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    composite_types list(object)
    Sub-schemas for this composite type (oneof, anyof, or allof). Each entry must be a schema_type_reference pointing to an apischema. Field introduced in 32.1.4. Maximum of 64 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    configpb_attributes list(object)
    Protobuf versioning for config pbs. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    description string
    Description of this api schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    discriminators list(object)
    Property used to distinguish between sub-schemas in oneof/anyof composite types. Maps a discriminator property value to the matching schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    id string
    max_items string
    Maximum number of items allowed in an array. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    min_items string
    Minimum number of items allowed in an array. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name string
    Name of this object, unique per tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    object_properties list(object)
    List of properties for this object schema. Field introduced in 32.1.4. Maximum of 512 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    source string
    Indicates whether this schema was user-defined or imported from an openapi specification file. Enum options - SOURCE_USER_DEFINED, SOURCE_API_SPEC, SOURCE_DISCOVERED. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenant_ref string
    It is a reference to an object of type tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    type string
    The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    unique_items string
    If true, all items in the array must be unique. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid string
    The object uuid. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    additionalObjectKeyAction String
    Action to take on unspecified keys in an object. Enum options - API_ACTION_INHERIT_FROM_API_POLICY, API_ACTION_PASS, API_ACTION_FLAG, API_ACTION_REJECT. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    additionalPropertiesSchemas List<GetApischemaAdditionalPropertiesSchema>
    Type constraint for additional properties not defined in object_properties. When set, unknown keys must conform to this schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    allowAdditionalProperties String
    When true, object keys not defined in object_properties are permitted. Corresponds to openapi additionalproperties true. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    arrayItemTypes List<GetApischemaArrayItemType>
    If the type is array, this is the type of the array items. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    compositeTypes List<GetApischemaCompositeType>
    Sub-schemas for this composite type (oneof, anyof, or allof). Each entry must be a schema_type_reference pointing to an apischema. Field introduced in 32.1.4. Maximum of 64 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    configpbAttributes List<GetApischemaConfigpbAttribute>
    Protobuf versioning for config pbs. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    description String
    Description of this api schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    discriminators List<GetApischemaDiscriminator>
    Property used to distinguish between sub-schemas in oneof/anyof composite types. Maps a discriminator property value to the matching schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    id String
    maxItems String
    Maximum number of items allowed in an array. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    minItems String
    Minimum number of items allowed in an array. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name String
    Name of this object, unique per tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    objectProperties List<GetApischemaObjectProperty>
    List of properties for this object schema. Field introduced in 32.1.4. Maximum of 512 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    source String
    Indicates whether this schema was user-defined or imported from an openapi specification file. Enum options - SOURCE_USER_DEFINED, SOURCE_API_SPEC, SOURCE_DISCOVERED. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenantRef String
    It is a reference to an object of type tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    type String
    The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uniqueItems String
    If true, all items in the array must be unique. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid String
    The object uuid. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    additionalObjectKeyAction string
    Action to take on unspecified keys in an object. Enum options - API_ACTION_INHERIT_FROM_API_POLICY, API_ACTION_PASS, API_ACTION_FLAG, API_ACTION_REJECT. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    additionalPropertiesSchemas GetApischemaAdditionalPropertiesSchema[]
    Type constraint for additional properties not defined in object_properties. When set, unknown keys must conform to this schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    allowAdditionalProperties string
    When true, object keys not defined in object_properties are permitted. Corresponds to openapi additionalproperties true. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    arrayItemTypes GetApischemaArrayItemType[]
    If the type is array, this is the type of the array items. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    compositeTypes GetApischemaCompositeType[]
    Sub-schemas for this composite type (oneof, anyof, or allof). Each entry must be a schema_type_reference pointing to an apischema. Field introduced in 32.1.4. Maximum of 64 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    configpbAttributes GetApischemaConfigpbAttribute[]
    Protobuf versioning for config pbs. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    description string
    Description of this api schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    discriminators GetApischemaDiscriminator[]
    Property used to distinguish between sub-schemas in oneof/anyof composite types. Maps a discriminator property value to the matching schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    id string
    maxItems string
    Maximum number of items allowed in an array. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    minItems string
    Minimum number of items allowed in an array. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name string
    Name of this object, unique per tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    objectProperties GetApischemaObjectProperty[]
    List of properties for this object schema. Field introduced in 32.1.4. Maximum of 512 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    source string
    Indicates whether this schema was user-defined or imported from an openapi specification file. Enum options - SOURCE_USER_DEFINED, SOURCE_API_SPEC, SOURCE_DISCOVERED. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenantRef string
    It is a reference to an object of type tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    type string
    The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uniqueItems string
    If true, all items in the array must be unique. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid string
    The object uuid. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    additional_object_key_action str
    Action to take on unspecified keys in an object. Enum options - API_ACTION_INHERIT_FROM_API_POLICY, API_ACTION_PASS, API_ACTION_FLAG, API_ACTION_REJECT. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    additional_properties_schemas Sequence[GetApischemaAdditionalPropertiesSchema]
    Type constraint for additional properties not defined in object_properties. When set, unknown keys must conform to this schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    allow_additional_properties str
    When true, object keys not defined in object_properties are permitted. Corresponds to openapi additionalproperties true. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    array_item_types Sequence[GetApischemaArrayItemType]
    If the type is array, this is the type of the array items. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    composite_types Sequence[GetApischemaCompositeType]
    Sub-schemas for this composite type (oneof, anyof, or allof). Each entry must be a schema_type_reference pointing to an apischema. Field introduced in 32.1.4. Maximum of 64 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    configpb_attributes Sequence[GetApischemaConfigpbAttribute]
    Protobuf versioning for config pbs. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    description str
    Description of this api schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    discriminators Sequence[GetApischemaDiscriminator]
    Property used to distinguish between sub-schemas in oneof/anyof composite types. Maps a discriminator property value to the matching schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    id str
    max_items str
    Maximum number of items allowed in an array. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    min_items str
    Minimum number of items allowed in an array. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name str
    Name of this object, unique per tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    object_properties Sequence[GetApischemaObjectProperty]
    List of properties for this object schema. Field introduced in 32.1.4. Maximum of 512 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    source str
    Indicates whether this schema was user-defined or imported from an openapi specification file. Enum options - SOURCE_USER_DEFINED, SOURCE_API_SPEC, SOURCE_DISCOVERED. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenant_ref str
    It is a reference to an object of type tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    type str
    The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    unique_items str
    If true, all items in the array must be unique. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid str
    The object uuid. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    additionalObjectKeyAction String
    Action to take on unspecified keys in an object. Enum options - API_ACTION_INHERIT_FROM_API_POLICY, API_ACTION_PASS, API_ACTION_FLAG, API_ACTION_REJECT. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    additionalPropertiesSchemas List<Property Map>
    Type constraint for additional properties not defined in object_properties. When set, unknown keys must conform to this schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    allowAdditionalProperties String
    When true, object keys not defined in object_properties are permitted. Corresponds to openapi additionalproperties true. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    arrayItemTypes List<Property Map>
    If the type is array, this is the type of the array items. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    compositeTypes List<Property Map>
    Sub-schemas for this composite type (oneof, anyof, or allof). Each entry must be a schema_type_reference pointing to an apischema. Field introduced in 32.1.4. Maximum of 64 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    configpbAttributes List<Property Map>
    Protobuf versioning for config pbs. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    description String
    Description of this api schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    discriminators List<Property Map>
    Property used to distinguish between sub-schemas in oneof/anyof composite types. Maps a discriminator property value to the matching schema. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    id String
    maxItems String
    Maximum number of items allowed in an array. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    minItems String
    Minimum number of items allowed in an array. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name String
    Name of this object, unique per tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    objectProperties List<Property Map>
    List of properties for this object schema. Field introduced in 32.1.4. Maximum of 512 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    source String
    Indicates whether this schema was user-defined or imported from an openapi specification file. Enum options - SOURCE_USER_DEFINED, SOURCE_API_SPEC, SOURCE_DISCOVERED. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenantRef String
    It is a reference to an object of type tenant. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    type String
    The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uniqueItems String
    If true, all items in the array must be unique. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid String
    The object uuid. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

    Supporting Types

    GetApischemaAdditionalPropertiesSchema

    MaxValue string
    MinValue string
    SchemaRef string
    StringEnumValues List<string>
    StringFormat string
    StringMaxLength string
    StringMinLength string
    StringPattern string
    Type string
    The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    MaxValue string
    MinValue string
    SchemaRef string
    StringEnumValues []string
    StringFormat string
    StringMaxLength string
    StringMinLength string
    StringPattern string
    Type string
    The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    max_value string
    min_value string
    schema_ref string
    string_enum_values list(string)
    string_format string
    string_max_length string
    string_min_length string
    string_pattern string
    type string
    The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    maxValue String
    minValue String
    schemaRef String
    stringEnumValues List<String>
    stringFormat String
    stringMaxLength String
    stringMinLength String
    stringPattern String
    type String
    The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    maxValue string
    minValue string
    schemaRef string
    stringEnumValues string[]
    stringFormat string
    stringMaxLength string
    stringMinLength string
    stringPattern string
    type string
    The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    max_value str
    min_value str
    schema_ref str
    string_enum_values Sequence[str]
    string_format str
    string_max_length str
    string_min_length str
    string_pattern str
    type str
    The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    maxValue String
    minValue String
    schemaRef String
    stringEnumValues List<String>
    stringFormat String
    stringMaxLength String
    stringMinLength String
    stringPattern String
    type String
    The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

    GetApischemaArrayItemType

    MaxValue string
    MinValue string
    SchemaRef string
    StringEnumValues List<string>
    StringFormat string
    StringMaxLength string
    StringMinLength string
    StringPattern string
    Type string
    The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    MaxValue string
    MinValue string
    SchemaRef string
    StringEnumValues []string
    StringFormat string
    StringMaxLength string
    StringMinLength string
    StringPattern string
    Type string
    The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    max_value string
    min_value string
    schema_ref string
    string_enum_values list(string)
    string_format string
    string_max_length string
    string_min_length string
    string_pattern string
    type string
    The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    maxValue String
    minValue String
    schemaRef String
    stringEnumValues List<String>
    stringFormat String
    stringMaxLength String
    stringMinLength String
    stringPattern String
    type String
    The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    maxValue string
    minValue string
    schemaRef string
    stringEnumValues string[]
    stringFormat string
    stringMaxLength string
    stringMinLength string
    stringPattern string
    type string
    The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    max_value str
    min_value str
    schema_ref str
    string_enum_values Sequence[str]
    string_format str
    string_max_length str
    string_min_length str
    string_pattern str
    type str
    The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    maxValue String
    minValue String
    schemaRef String
    stringEnumValues List<String>
    stringFormat String
    stringMaxLength String
    stringMinLength String
    stringPattern String
    type String
    The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

    GetApischemaCompositeType

    MaxValue string
    MinValue string
    SchemaRef string
    StringEnumValues List<string>
    StringFormat string
    StringMaxLength string
    StringMinLength string
    StringPattern string
    Type string
    The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    MaxValue string
    MinValue string
    SchemaRef string
    StringEnumValues []string
    StringFormat string
    StringMaxLength string
    StringMinLength string
    StringPattern string
    Type string
    The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    max_value string
    min_value string
    schema_ref string
    string_enum_values list(string)
    string_format string
    string_max_length string
    string_min_length string
    string_pattern string
    type string
    The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    maxValue String
    minValue String
    schemaRef String
    stringEnumValues List<String>
    stringFormat String
    stringMaxLength String
    stringMinLength String
    stringPattern String
    type String
    The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    maxValue string
    minValue string
    schemaRef string
    stringEnumValues string[]
    stringFormat string
    stringMaxLength string
    stringMinLength string
    stringPattern string
    type string
    The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    max_value str
    min_value str
    schema_ref str
    string_enum_values Sequence[str]
    string_format str
    string_max_length str
    string_min_length str
    string_pattern str
    type str
    The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    maxValue String
    minValue String
    schemaRef String
    stringEnumValues List<String>
    stringFormat String
    stringMaxLength String
    stringMinLength String
    stringPattern String
    type String
    The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

    GetApischemaConfigpbAttribute

    CreatedBy string
    Version string
    CreatedBy string
    Version string
    created_by string
    version string
    createdBy String
    version String
    createdBy string
    version string
    createdBy String
    version String

    GetApischemaDiscriminator

    GetApischemaDiscriminatorMapping

    GetApischemaObjectProperty

    AccessMode string
    Deprecated string
    Name string
    Search ApiSchema by name.
    Nullable string
    Required string
    Schemas List<GetApischemaObjectPropertySchema>
    AccessMode string
    Deprecated string
    Name string
    Search ApiSchema by name.
    Nullable string
    Required string
    Schemas []GetApischemaObjectPropertySchema
    access_mode string
    deprecated string
    name string
    Search ApiSchema by name.
    nullable string
    required string
    schemas list(object)
    accessMode String
    deprecated String
    name String
    Search ApiSchema by name.
    nullable String
    required String
    schemas List<GetApischemaObjectPropertySchema>
    accessMode string
    deprecated string
    name string
    Search ApiSchema by name.
    nullable string
    required string
    schemas GetApischemaObjectPropertySchema[]
    accessMode String
    deprecated String
    name String
    Search ApiSchema by name.
    nullable String
    required String
    schemas List<Property Map>

    GetApischemaObjectPropertySchema

    MaxValue string
    MinValue string
    SchemaRef string
    StringEnumValues List<string>
    StringFormat string
    StringMaxLength string
    StringMinLength string
    StringPattern string
    Type string
    The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    MaxValue string
    MinValue string
    SchemaRef string
    StringEnumValues []string
    StringFormat string
    StringMaxLength string
    StringMinLength string
    StringPattern string
    Type string
    The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    max_value string
    min_value string
    schema_ref string
    string_enum_values list(string)
    string_format string
    string_max_length string
    string_min_length string
    string_pattern string
    type string
    The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    maxValue String
    minValue String
    schemaRef String
    stringEnumValues List<String>
    stringFormat String
    stringMaxLength String
    stringMinLength String
    stringPattern String
    type String
    The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    maxValue string
    minValue string
    schemaRef string
    stringEnumValues string[]
    stringFormat string
    stringMaxLength string
    stringMinLength string
    stringPattern string
    type string
    The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    max_value str
    min_value str
    schema_ref str
    string_enum_values Sequence[str]
    string_format str
    string_max_length str
    string_min_length str
    string_pattern str
    type str
    The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    maxValue String
    minValue String
    schemaRef String
    stringEnumValues List<String>
    stringFormat String
    stringMaxLength String
    stringMinLength String
    stringPattern String
    type String
    The data type of this schema. Can be object, array, or a composite type (oneof, anyof, allof). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

    Package Details

    Repository
    avi vmware/terraform-provider-avi
    License
    Notes
    This Pulumi package is based on the avi Terraform Provider.
    avi
    Viewing docs for avi 32.1.4
    published on Friday, Oct 23, 2026 by vmware
    Schema (JSON)
    vmware/terraform-provider-avi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial